-
Notifications
You must be signed in to change notification settings - Fork 6
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
Update docs #189
Merged
Merged
Update docs #189
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
- Capitalise Juju and MicroK8s where appropriate - Update outdated commands - Remove broken links in the "What you'll do" section - Remove words for conciseness
Add a "the"
- Capitalise Pebble where appropriate - Update list items to contain the same grammatical structure.
- Moved the code block higher in the section (I think it makes more sense for the `update-status` text to appear after the code block; please let me know if you disagree!) - Fixed a fragmented sentence - Other grammatical changes
- Capitalise Juju where appropriate - Change the "considerations" header to be one level lower than the "how to" header
I removed the `--wait` flag because it now requires an argument. I'm not opposed to adding it back, but I would need guidance on an appropriate value to include.
Made "Networking considerations" heading one level lower than the "how to" heading.
Removed the second section and moved text around for conciseness. Also updated the steps to have the same grammatical structure.
Fix broken links; small grammatical changes
Updated an outdated command (removed the `--wait` flag, but not opposed to putting it back in); explicitly labeled the password as new
Fixed a fragmented sentence; grammatical change in last sentence
erinecon
added
documentation
Improvements or additions to documentation
trivial
This is a trivial PR
labels
Sep 6, 2024
Test coverage for 6dd3551
Static code analysis report
|
arturo-seijas
approved these changes
Sep 9, 2024
yanksyoon
approved these changes
Sep 9, 2024
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.
LGTM!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
Libraries: Out of sync
trivial
This is a trivial PR
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.
Overview
Small changes to the documentation that are specific to the jenkins-k8s charm.
Rationale
Juju Events Changes
None
Module Changes
None
Library Changes
None
Checklist
src-docs
urgent
,trivial
,complex
)