Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Lack of consistency/clarity in code sections #3527

Open
migueldivo opened this issue Oct 21, 2024 · 0 comments
Open

Documentation: Lack of consistency/clarity in code sections #3527

migueldivo opened this issue Oct 21, 2024 · 0 comments

Comments

@migueldivo
Copy link

Docs page: https://juju.is/docs/juju/set-up--tear-down-your-test-environment

Docs source: https://discourse.charmhub.io/t/set-up-tear-down-your-test-environment/13403

Issue: There is a lack of consistency in the way command lines are being displayed throughout the page. Some command lines follow the convention of using '$' to indicate its a command line, but other instances either have nothing to show its a command line, or uses a '#' which means its a comment rather than an action the user should do.

Below are some examples where this is present throughout the page. Command lines should be consistently represented with the '$' to allow users to know what are command lines and what are comments/session sample outputs.

Example that follows standard of using '$' for CLI inputs
image

Example that does not follow '$' standard, either does not include '$' or uses a '#' which makes a comment
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant