Skip to content

docs: revise lists in the Design the image section - #96

Open
archisha-g wants to merge 2 commits into
canonical:mainfrom
archisha-g:patch-1
Open

archisha-g wants to merge 2 commits into
canonical:mainfrom
archisha-g:patch-1

Conversation

@archisha-g

Copy link
Copy Markdown

Fixes canonical/open-documentation-academy#377

What changed

  • The goals list stays a bulleted list, since it is a complete set of equal requirements with no order. I added a lead-in sentence ("The image must meet these goals") so the list is introduced.
  • The numbered list of build stages is now prose. It was a single sentence split across two numbered items, and it covered only two of the three stages (the final stage followed in a separate "Finally" paragraph). As one sentence, the whole sequence reads together, and the detailed numbered steps follow later on the page.

Why

The Ubuntu style guide says to use numbered lists only when order matters for steps the reader follows and bullets or prose otherwise. Only the "Design the image" section is changed.

Signed-off-by: Archisha Ghanshani <archishaghanshani@gmail.com>

@asanvaq asanvaq left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Thank you for your contribution! It looks very good, I just have a small suggestion on the first list.

Comment thread docs/how-to/use-chisel-in-dockerfile.md Resolved
Co-authored-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: Archisha Ghanshani <archishaghanshani@gmail.com>
@archisha-g

Copy link
Copy Markdown
Author

Thanks @asanvaq, I’ve applied your suggestion, and that reads much better. Let me know if anything else needs changing!

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

Successfully merging this pull request may close these issues.

Chisel: ensure style guide is followed in "Design a slice"

2 participants