Skip to content

Commit

Permalink
docs: Remove "rst" from spelling exceptions
Browse files Browse the repository at this point in the history
There is no need to accept "rst" as a valid word. For referencing the
mark-up language, "rST" (ideally) or "RST" should be used. For
referencing rST files in the repository, literals should be used.

Signed-off-by: Quentin Monnet <[email protected]>
  • Loading branch information
qmonnet committed Apr 23, 2024
1 parent 0f75a12 commit 5948c1e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Documentation/contributing/development/dev_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -789,9 +789,9 @@ Minor version
are up to date with these changes.
#. Update documentation files:
- Documentation/contributing/testing/e2e.rst
- Documentation/network/kubernetes/compatibility.rst
- Documentation/network/kubernetes/requirements.rst
- ``Documentation/contributing/testing/e2e.rst``
- ``Documentation/network/kubernetes/compatibility.rst``
- ``Documentation/network/kubernetes/requirements.rst``
#. Update the Kubernetes version with the newer version in ``test/Vagrantfile``,
``test/test_suite_test.go`` and ``test/vagrant-local-start.sh``.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/security/network/proxy/envoy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -618,8 +618,8 @@ Step 15: Write Docs or Getting Started Guide (optional)
At a minimum, the policy examples included as part of the runtime tests serve
as basic documentation of the policy and its expected behavior. But we also
encourage adding more user friendly examples and documentation, for example,
Getting Started Guides. cilium/Documentation/gettingstarted/cassandra.rst is
a good example to follow. Also be sure to update Documentation/gettingstarted/index.rst
Getting Started Guides. ``cilium/Documentation/gettingstarted/cassandra.rst`` is
a good example to follow. Also be sure to update ``Documentation/gettingstarted/index.rst``
with a link to this new getting started guide.

With that, you are ready to post this change for feedback from the Cilium community. Congrats!
1 change: 0 additions & 1 deletion Documentation/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,6 @@ roadmap
rollout
routable
routingMode
rst
runnable
runtimes
sandboxing
Expand Down

0 comments on commit 5948c1e

Please sign in to comment.