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

[v1.13] docs: Ignore Helm values, update spelling list #26906

Merged
merged 5 commits into from
Jul 27, 2023
Merged

[v1.13] docs: Ignore Helm values, update spelling list #26906

merged 5 commits into from
Jul 27, 2023
+627 −1,039

Commits on Jul 27, 2023

  1. docs: Fix double reference in benchmark docs 

    [ upstream commit 0916eac ]

There are two target references (non-anonymous links) names "netperf",
and pointing to the same link anyway. Let's clean it up.

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
    @qmonnet
    qmonnet committed Jul 27, 2023
    Configuration menu
    Copy the full SHA
    e31e82f View commit details
    Browse the repository at this point in the history

  2. docs: Fix indentation of a table in CI docs 

    [ upstream commit daaf1d2 ]

The table should be indented with the item list it belongs to, or Sphinx
will believe the list is finished and open a new one, under the table,
starting from 3.

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
    @qmonnet
    qmonnet committed Jul 27, 2023
    Configuration menu
    Copy the full SHA
    c8753c9 View commit details
    Browse the repository at this point in the history

  3. docs: Backport changes to documentation framework 

    We want to backport some changes touching the structure of the Helm
reference. This requires using a specific role with the spelling plug-in
for Sphinx, which in turn requires upgrading this spelling plug-in to a
newer version. This upgrade requires the creation of a new CI image, but
it seems that building the image locally is broken on 1.13...

Let's just copy most of the Documentation framework files from main to
branch 1.13, and use the same image in CI.

Upstream commits (not sorted):

  - 0b93dcc ("docs: Revert Python to 3.7.9 in docs-builder, downgrade a dependency")
  - 36a31b1 ("Documentation: enable parallel builds")
  - 2e9b20f ("docs: Ignore Helm value names for spellcheck")
  - b445e6e ("docs: Do not print error when spell check output dir is empty")
  - e90df2f ("docs: Update rstcheck")
  - 621dcad ("docs: extract Go version from go.mod")
  - b304ce3 ("Update release scripting for main branch rename")
  - eb1338a ("docs: Update build dependencies (Sphinx add-ons etc.)")
  - 2390916 ("docs: fixed search for every page")

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
    @qmonnet
    qmonnet committed Jul 27, 2023
    Configuration menu
    Copy the full SHA
    f609967 View commit details
    Browse the repository at this point in the history

  4. docs: Ignore Helm value names for spellcheck 

    [ upstream commit 2e9b20f ]

Updating the list of exceptions for spellchecking each time we add a
Helm value is painfull, and hardly useful at all. It's trivial to mark
these strings as ignored to the spell-checker when building the
reference, so let's just do that.

[ Backport note: We have cherry-picked the changes to the Makefile in a
    previous commit, here we just update the Helm reference to mark the
    values as ignored for the spell checker. ]

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
    @qmonnet
    qmonnet committed Jul 27, 2023
    Configuration menu
    Copy the full SHA
    9a1f4e6 View commit details
    Browse the repository at this point in the history

  5. docs: Trim down spelling list 

    [ upstream commit e846b71 ]

We have accumulated a number of words in the spelling list over time,
and some of them are no longer necessary (especially now that we ignore
Helm value names from the Helm reference). Let's trim down the list.

The following process was applied:

    1. Empty the list of spelling exceptions
    2. Run 'make html' to get the command to add missing words
       (update-spelling_wordlist.sh)
    3. Run that command to add all words
    4. Remove all entries starting with an upper case from the list, as
       some of them are unnecessary given that they have a corresponding
       lowercase entry (which is case-insensitive)
    5. Re-run 'make html' to get the command to add the exceptions that
       are still missing
    6. Run that command
    7. Manually edit the file to make sure we don't change/add existing
       entries (no Git addition)
    8. Re-add names of contributors that are recognised locally, but
       that CI fails to recognise because it doesn't have the Git
       history

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
    @qmonnet
    qmonnet committed Jul 27, 2023
    Configuration menu
    Copy the full SHA
    df0a686 View commit details
    Browse the repository at this point in the history