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.

Sign up for GitHub

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

Jump to bottom

issue-200 updated modules sections and templates #208

Merged
merged 5 commits into from
Aug 1, 2023
Merged

issue-200 updated modules sections and templates #208

merged 5 commits into from
Aug 1, 2023

Conversation

emmurphy1
Copy link
Collaborator

No description provided.

@emmurphy1 emmurphy1 requested a review from a team as a code owner July 10, 2023 19:03
IanFrangs
IanFrangs approved these changes Jul 11, 2023
View reviewed changes
Copy link
Collaborator

@IanFrangs IanFrangs left a comment

Choose a reason for hiding this comment

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

I have read through all of the proposed changes and they all look good to me, I do not see anything that I can comment on or correct.

@Jenny-Anne
Copy link
Collaborator

Jenny-Anne commented Jul 11, 2023 •
edited
Loading

Hi @emmurphy1,

While we're updating the parts in a procedure module, can we consider adding an optional .Limitations section to the procedure template (or at least a guideline about optional extra sections)? I was going to use a [discrete] heading for a Limitations section but I've seen a good few examples of a .Limitations heading being used in our docs repo instead (before the .Procedure section, and in some case before a .Prerequisites section). There are also examples of a .Troubleshooting section after the .Procedure section or after the .Verification section.

@emmurphy1
Copy link
Collaborator Author

@Jenny-Anne let's discuss Limitations at the meeting tomorrow.

ncbaratta
ncbaratta reviewed Jul 12, 2023
View reviewed changes
modular-docs-manual/content/topics/creating_procedure_modules.adoc Outdated Show resolved Hide resolved
modular-docs-manual/content/topics/creating_procedure_modules.adoc Outdated Show resolved Hide resolved
modular-docs-manual/content/topics/creating_procedure_modules.adoc Outdated

* Limitations
* Prerequisites
* Verification or Verification steps
Copy link
Member

Choose a reason for hiding this comment

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

do we need 'steps'?

modular-docs-manual/content/topics/creating_procedure_modules.adoc Outdated Show resolved Hide resolved
Jenny-Anne
Jenny-Anne reviewed Jul 12, 2023
View reviewed changes
modular-docs-manual/content/topics/creating_procedure_modules.adoc Outdated
.Procedure prerequisites
This section is optional. Prerequisites are a bulleted list of conditions that must be satisfied before the user starts the procedure. Use a bulleted list for prerequisites and the plural heading *Prerequisites*, even if you only have a single prerequisite.
.Limitations
This section is optional and not used often. If there are any limitations that the affect the procedure, list them in this section.
Copy link
Collaborator

Choose a reason for hiding this comment

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

delete the first "the" in "any limitations that the affect the procedure"

ncbaratta
ncbaratta approved these changes Jul 17, 2023
View reviewed changes
Copy link
Member

@ncbaratta ncbaratta left a comment

Choose a reason for hiding this comment

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

lgtm

@neal-timpe neal-timpe self-requested a review July 20, 2023 15:43
@mjahoda
Copy link
Contributor

mjahoda commented Jul 21, 2023

This is a huge improvement of the procedure guidelines. Thank you for preparing it.

@emmurphy1 emmurphy1 merged commit 92be0f2 into main Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jenny-Anne Jenny-Anne Jenny-Anne left review comments

@IanFrangs IanFrangs IanFrangs approved these changes

@ncbaratta ncbaratta ncbaratta approved these changes

@thatdocslady thatdocslady thatdocslady approved these changes

@neal-timpe neal-timpe neal-timpe approved these changes

@mjahoda mjahoda mjahoda approved these changes

@abhatt-rh abhatt-rh abhatt-rh approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@emmurphy1 @Jenny-Anne @mjahoda @ncbaratta @thatdocslady @neal-timpe @abhatt-rh @IanFrangs