Skip to content

Commit

Permalink
Ssh guide (#374)
Browse files Browse the repository at this point in the history
* A few renames, to make the case consistent in build/electrical

* missed some things

* Updated the site to use the new Just-the-Docs Callout system for the warning messages
Also added a new "note" callout, though I'm not completely happy with it yet.

* fully enabled new style klipper callout boxes

* added new ssh quick guide
  • Loading branch information
shiftingtech authored Jul 15, 2023
1 parent ccd292e commit 71e0faf
Show file tree
Hide file tree
Showing 19 changed files with 261 additions and 16 deletions.
16 changes: 15 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
layout: default
name: Voron Documentation
title: Voron Documentation
description: Voron Official and Community Documentation
logo: "/images/voron_design_logo.png"
markdown: kramdown
remote_theme: pmarsceill/just-the-docs
remote_theme: just-the-docs/just-the-docs
color_scheme: voron-dark
search_enabled: true
search.button: true
Expand All @@ -13,3 +14,16 @@ aux_links:
"VoronDesign Home":
- "https://vorondesign.com"

callouts:
warning:
title: Warning
color: voron-red
note:
title: Note
color: grey-lt

mermaid:
# Version of mermaid library
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "10.2.4"

8 changes: 0 additions & 8 deletions _sass/color_schemes/voron-dark.scss
Original file line number Diff line number Diff line change
Expand Up @@ -247,11 +247,3 @@ $feedback-color: darken($sidebar-color, 3%);
.highlight .il {
color: #2aa198;
} // literal.number.integer.long //

.warning {
padding: 10px;
background-color: darken($voron-red-80, 30%);
border-width: 1px;
border-color: $voron-red-50;
border-style: solid;
}
9 changes: 7 additions & 2 deletions build/electrical/v1_octopus_wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ nav_exclude: true

# Voron V1.8/Trident - Octopus (Pro) Wiring

<div><b>WARNING:</b> Do not leave HE0 or HE1 connected.
<p>There have been reports of Octopus boards coming preloaded with a firmware that turns on all heaters and fans as soon as you power up the board. As a result, we recommend leaving the heaters disconnected until after loading the klipper firmware</p></div>


{: .warning }
>Do not leave HE0 or HE1 connected.
>
>There have been reports of Octopus boards coming preloaded with a firmware that turns on all heaters and fans as soon as you power up the board. As a result, we
>recommend leaving the heaters disconnected until after loading the klipper firmware

## Initial Preparation

Expand Down
8 changes: 5 additions & 3 deletions build/electrical/v2_octopus_wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ nav_exclude: true

# Voron V2 - BigTreeTech Octopus Wiring

<div><b>WARNING:</b> Do not leave HE0 or HE1 connected.
<p>There have been reports of Octopus boards coming preloaded with a firmware that turns on all heaters and fans as soon as you power up the board. As a result, we recommend leaving the heaters disconnected until after loading the klipper firmware</p></div>
{: .warning }
>Do not leave HE0 or HE1 connected.
>
>There have been reports of Octopus boards coming preloaded with a firmware that turns on all heaters and fans as soon as you power up the board. As a result, we
>recommend leaving the heaters disconnected until after loading the klipper firmware
## Initial Preparation

Expand All @@ -31,7 +33,7 @@ Set jumpers as shown:
* Connect the A Motor (gantry right) to MOTOR1
* Connect the Z (Front Left) motor to MOTOR2_1
* Connect the Z1 (Rear left) motor to MOTOR3
* Connect the Z2 (Rear right motor to MOTOR4
* Connect the Z2 (Rear right) motor to MOTOR4
* Connect the Z3 (Front right) motor to MOTOR5
* Connect the extruder motor to MOTOR6
* Connect the hot end heater to HE0 ( do not leave connected )
Expand Down
Binary file added build/software/images/angryip_fetchers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/angryip_prefs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/angryip_results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/filezilla.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/linux_prompt_basic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/linux_prompt_cd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/linux_prompt_ls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/nano-readonly.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/nano.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added build/software/images/putty_password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions build/software/octopus_klipper.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ nav_exclude: true

# Octopus(Pro) Klipper Firmware

<div><b>WARNING:</b> Do not leave HE0 or HE1 connected.
<p>There have been reports of Octopus boards coming preloaded with a firmware that turns on all heaters and fans as soon as you power up the board. As a result, we recommend leaving the heaters disconnected until after loading the klipper firmware</p></div>

{: .warning }
>Do not leave HE0 or HE1 connected during initial flashing
>
>There have been reports of Octopus boards coming preloaded with a firmware that turns on all heaters and fans as soon as you power up the board. As a result, we >recommend leaving the heaters disconnected until after loading the klipper firmware

The firmware update process for both Octopus and Octopus Pro is the same so the guides have been combined.

Expand Down
229 changes: 229 additions & 0 deletions build/software/ssh.md

Large diffs are not rendered by default.

0 comments on commit 71e0faf

Please sign in to comment.