Update manifest installation guide, fix theme highlighting & spec table #4066
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
This commit includes two small changes: the first is removing a line from the Hugo configuration file that was preventing the appropriate styling to occur for code blocks. The second is to fix an incorrectly closed table in the technical specifications page. The largest change is reformatting of the Installation with Manifests page. Multiple sections of the page now have horizontal lines to separate them visually: many instances of notes were replaced with the formal Hugo shortcode for notes. Indentation was also fixed in multiple places, with subheadings being used to create explicit flow where previously it was implicit. Finally, there are multiple instances of nouns being fixed, as well as certain portions of text being rephrased for clarity or conciseness.
for more information, see https://pre-commit.ci
Dependency Review✅ No vulnerabilities or license issues found.Scanned Manifest Files |
Codecov Report
@@ Coverage Diff @@
## main #4066 +/- ##
=======================================
Coverage 51.84% 51.84%
=======================================
Files 59 59
Lines 16710 16710
=======================================
Hits 8664 8664
Misses 7747 7747
Partials 299 299 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
vepatel
approved these changes
Jun 29, 2023
shaun-nx
reviewed
Jun 29, 2023
shaun-nx
approved these changes
Jun 29, 2023
jputrino
reviewed
Jul 10, 2023
Signed-off-by: Jodie Putrino <j.putrino@f5.com>
jputrino
approved these changes
Jul 10, 2023
ADubhlaoich
added a commit
that referenced
this pull request
Jul 13, 2023
…le (#4066) * Update manifest installation guide, fix theme highlighting & spec table This commit includes two small changes: the first is removing a line from the Hugo configuration file that was preventing the appropriate styling to occur for code blocks. The second is to fix an incorrectly closed table in the technical specifications page. The largest change is reformatting of the Installation with Manifests page. Multiple sections of the page now have horizontal lines to separate them visually: many instances of notes were replaced with the formal Hugo shortcode for notes. Indentation was also fixed in multiple places, with subheadings being used to create explicit flow where previously it was implicit. Finally, there are multiple instances of nouns being fixed, as well as certain portions of text being rephrased for clarity or conciseness. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fixes duplicated word in manifest install guide Signed-off-by: Jodie Putrino <j.putrino@f5.com> --------- Signed-off-by: Jodie Putrino <j.putrino@f5.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jodie Putrino <j.putrino@f5.com>
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.
Proposed changes
This commit includes two small changes: the first is removing a line from the Hugo configuration file that was preventing the appropriate styling to occur for code blocks. The second is to fix an incorrectly closed table in the technical specifications page.
The largest change is reformatting of the Installation with Manifests page. Multiple sections of the page now have horizontal lines to separate them visually: many instances of notes were replaced with the formal Hugo shortcode for notes. Indentation was also fixed in multiple places, with subheadings being used to create explicit flow where previously it was implicit.
Finally, there are multiple instances of nouns being fixed, as well as certain portions of text being rephrased for clarity or conciseness.
Checklist
Before creating a PR, run through this checklist and mark each as complete.