canonical / rockcraft

Tool to create OCI Images using the language from Snapcraft and Charmcraft.
GNU General Public License v3.0
34 stars 42 forks source link

Improve article "Parts and Steps" #628

Open hd9 opened 2 months ago

hd9 commented 2 months ago

Request type

Enhancement

What needs to get done

This is a request to improve the Parts and Steps article.

The following points are not clear for a new rock developer:

  1. craft-parts in the first phrase. Are we talking about Parts, or is this a new concept?
  2. The word project in the article is generic and is not clear in this context. The reader would not know if we’re talking about a generic software project, or if this is a concept related to rocks or rockcraft.

Suggestions:

  1. If craft-parts means Parts, link to it. Else, provide more information.
  2. Clarify what project is. Is this a term we use when building rocks?

Documentation location

https://documentation.ubuntu.com/rockcraft/en/latest/reference/parts_steps/

Additional information

No response