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.

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

Cherry pick minor changes (Including code highlighting fix) from main #4097

Merged
merged 2 commits into from
Jul 13, 2023

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jul 13, 2023

Proposed changes

This commit cherry picks two changes from the main branch onto the release branch to fix a lack of highlighting with codeblocks in the NGINX Ingress Controller documentation set. There are also two pages with coincidental changes included as part of the two picked commits.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

ADubhlaoich and others added 2 commits July 13, 2023 10:22
…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>
Fixes a typo in the GlobalConfiguration CRD step.

Signed-off-by: Jodie Putrino <j.putrino@f5.com>
Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner July 13, 2023 09:25
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jul 13, 2023
@github-actions
Copy link

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Manifest Files

@jjngx jjngx merged commit cebdf3b into release-3.2 Jul 13, 2023
@jjngx jjngx deleted the docs/highlight-fix-pick branch July 13, 2023 11:34
@jjngx jjngx restored the docs/highlight-fix-pick branch July 13, 2023 11:34
@ADubhlaoich ADubhlaoich deleted the docs/highlight-fix-pick branch September 13, 2023 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants