Flow improvement #43
Flow improvement #43
Conversation
mrbojangles3
requested review from
Frostman,
sergeymatov,
amitlimaye,
sonoble and
thedvorkin
as code owners
|
🚀 Deployed on https://preview-43--hedgehog-docs.netlify.app |
Co-authored-by: Quentin Monnet <[email protected]>
| @@ -12,7 +12,7 @@ After that you will be provided with the credentials to access the software on [ | |||
| In order to use the software, log in to the registry using the following command: | |||
|
|
|||
| ```bash | |||
| docker login ghcr.io | |||
| docker login ghcr.io --username provided_user_name --password provided_token_string | |||
There was a problem hiding this comment.
I am guessing that people will like to use the copy paste. But I am flexible.
| ```console | ||
| ``` |
There was a problem hiding this comment.
It doesn't matter much here - these blocks are console output, because they contain both commands and their output. However, we won't get the highlight for commands, because the core@control-1 prefix in front of the prompt symbol and commands prevents GitHub to recognise the commands.
There was a problem hiding this comment.
So I have been looking at the docs as rendered via make serve I did that mass removal to avoid numbers in the output being colored for reasons I couldn't easily deduce. For examples the first 10 in the ip addresses. The rendering in GitHub is something that I have only started looking at because of this comment. Are you okay with a policy of, no console tag at all since the rendering seems to be spotty be between material-mkdocs and github?
docs/vlab/overview.md
Outdated
| docker login ghcr.io --username provided_username --password provided_token | ||
| ``` | ||
|
|
||
| Hedgehog maintains a utility to install and configure VLAB, called `hhfab`. To install: |
There was a problem hiding this comment.
Hedgehog maintains a utility to install and configure VLAB, called
hhfab.
I'd move that to the top of the subsection, before mentioning the token required to download this hhfab you mention :)
Also s/github/GitHub/
No description provided.