oxidecomputer / oxidecomputer/omicron
Add documentation for technician port access to wicket.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
For first time setup, we expect that an operator will connect to the technician port, ssh to a particular address, and be taken to a captive shell.
Depending on our update process, this may need to be repeated for the other scrimlet.
We should have documentation for "what exactly should an operator be doing" during this process, and guidance for "what to do if things go wrong"
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by clarifying the first-time setup flow for connecting to the technician port, using SSH to the specified address, and entering the captive shell. Document what the operator should do, when the process must be repeated for the other scrimlet, and what to do when the process fails; the issue does not name a documentation file or test.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100