-
Notifications
You must be signed in to change notification settings - Fork 0
Quickstart template and example #45
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
base: main
Are you sure you want to change the base?
Conversation
05ac0d7 to
d219cc1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Chen -- In general the document works. I added some comments, though.
I haven't reviewed the document in full; the review only covers the content until my last comment. The reason is that we must change the tags we use in some sections (also for my procedure template) but I haven't fully figured out how yet.
Please update the document with my comments and send it back to me again for review. I will add my comments about the tags in my second review, but I need to clarify first how to use these tags.
Thank you.
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
manual/2-populate-the-structure/templates/template-quickstart.md
Outdated
Show resolved
Hide resolved
| > - 2 TB SSD | ||
| > - Linux 64-bit | ||
| ## Task guidelines: <!-- group: QST-TASK --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can remove the Task guidelines and Task procedural structure sections because for quickstarts we only have the "sectioned" model.
This includes lines 65 to 129.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left <!-- QST-TASK-001 -->, <!-- QST-TASK-002--> and <!-- QST-TASK-003 --> because they still seem relavent here, and they are not stated in the procedure template
| doc_type: # [procedure, concept, reference, quickstart, api] | ||
| product: # [codex, nomos, waku] | ||
| topics: [] | ||
| steps_layout: # [flat|sectioned] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed steps_layout: # [flat|sectioned] because a quickstart always use sectioned structure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the updates, @cheny0.
As discussed, we now need to update the document to reflect a new terminology for the IDs, where some define the structure (-STRUCT-) and some others define the behavior (-BEHAV-).
I have updated the procedure template and send you a PR so you can use what I did as reference. For all rules, you must update the ID and, for some of them, you must to split them when the same rule contains structural and behavioral references.
If something is unclear in my procedure template, let me know and we clarify it.
Thank you.
| - Write one or two 50 to 100-word paragraphs. Use an additional [concept](./concept-help-me-to-understand.md) article if you need to provide more information. <!-- QST-OVERVIEW-002 --> | ||
| - Link to related documents or headings in the same document to support the reader's gathering of information. <!-- QST-OVERVIEW-003 --> | ||
|
|
||
| ## "Before you start" (optional) guidelines <!-- group: QST-BEFORE-START --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see what you mean. Let's simplify things and remove the "guidelines" word in every title.
Your title will just read:
## "Before you start" (optional)
No description provided.