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

Docs: Hard to read line #736

Closed
rvveber opened this issue Apr 6, 2024 · 0 comments · Fixed by #742
Closed

Docs: Hard to read line #736

rvveber opened this issue Apr 6, 2024 · 0 comments · Fixed by #742
Assignees
Labels
Documentation Documentation needs updating Easy Good for new contributors
Milestone

Comments

@rvveber
Copy link

rvveber commented Apr 6, 2024

For example, to create a project called `my-project` that isolates instances, but allows access to the default project's images and profiles, enter the following command:

Upon reading this documentation, i came to a fullstop when reading this line.
... that isolates instances, but allows access to the default project’s images and profiles ...

  • Optimize the reading flow
  • No quickly injected knowledge about unrelated but important information
    If it is important, it should get its attention in peace, not in a hurry

Noone will copy and execute a command, without informing themselves about the meanings of the parameters.

@rvveber rvveber changed the title Issue/Docs: Hard to read line Docs: Hard to read line Apr 6, 2024
@stgraber stgraber self-assigned this Apr 8, 2024
@stgraber stgraber added this to the incus-6.1 milestone Apr 8, 2024
@stgraber stgraber added Documentation Documentation needs updating Easy Good for new contributors labels Apr 8, 2024
stgraber added a commit to stgraber/incus that referenced this issue Apr 8, 2024
Closes lxc#736

Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
@tych0 tych0 closed this as completed in #742 Apr 8, 2024
stgraber added a commit that referenced this issue May 27, 2024
Closes #736

Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating Easy Good for new contributors
Development

Successfully merging a pull request may close this issue.

2 participants