Add best practices page #6478
Merged
Add best practices page #6478
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add to _chapter and add docs
Add Administering Jenkins
Fix bad format
Make http://[jenkins-server]/[command] pretty
Refactor doc string
Add example picture and edit text.
Extract section to another page. * Extract `JENKINS_HOME` directory section to system-configuration.adoc * Extract Moving/Copying/Renaming jobs to create-project.adoc
Fix title and add to _chapter.yml
Make link on next line not same as intro.
|
@StackScribe, @JE-Chen, and @kmartens27 this is ready for your review |
|
LGTM |
Remember the rule of seven as described by Meg McRoberts. Readers are more likely to retain the contents of a list if it includes no more than 7 items.
gounthar
reviewed
Jul 7, 2023
Co-authored-by: Bruno Verachten <gounthar@gmail.com>
kmartens27
reviewed
Jul 7, 2023
kmartens27
reviewed
Jul 7, 2023
kmartens27
reviewed
Jul 7, 2023
kmartens27
reviewed
Jul 7, 2023
kmartens27
reviewed
Jul 7, 2023
kmartens27
reviewed
Jul 7, 2023
kmartens27
approved these changes
Jul 7, 2023
There was a problem hiding this comment.
This looks great @MarkEWaite, I provided a few suggestions for syntax/word choices, and some formatting/punctuation updates, but apply as you feel is appropriate.
Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com> Co-authored-by: Bruno Verachten <gounthar@gmail.com>
MarkEWaite
commented
Jul 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add best practices page
Extracted from the wiki by JE-Chen with addtions by MarkEWaite.
Fixes #3209
Must be squash merged
Would like reviews from:
Some text is still missing, but I think it is worth review even with the current gaps in the content.
Associated with
Second half of original pull request from @JE-Chen
See the prototype Best Practices page