Keep the contributor documentation accurate and renderable for current OVN development workflows. Correct wording and links without changing the submission policy.
Assisted-by: GPT-5.6-Luna, OpenCode Signed-off-by: Ales Musil <[email protected]> --- .../internals/contributing/backporting-patches.rst | 4 ++-- Documentation/internals/contributing/coding-style.rst | 4 ++-- .../internals/contributing/documentation-style.rst | 10 +++------- .../internals/contributing/inclusive-language.rst | 10 +++++----- .../internals/contributing/submitting-patches.rst | 2 +- 5 files changed, 13 insertions(+), 17 deletions(-) diff --git a/Documentation/internals/contributing/backporting-patches.rst b/Documentation/internals/contributing/backporting-patches.rst index 06ffb1d65..1b98d6286 100644 --- a/Documentation/internals/contributing/backporting-patches.rst +++ b/Documentation/internals/contributing/backporting-patches.rst @@ -36,8 +36,8 @@ Backporting patches The backporting of patches from one git tree to another takes multiple forms within OVN, but is broadly applied in the following fashion: -- Contributors submit their proposed changes to the latest development branch -- Contributors and maintainers provide feedback on the patches +- Contributors submit their proposed changes to the latest development branch. +- Contributors and maintainers provide feedback on the patches. - When the change is satisfactory, maintainers apply the patch to the development branch. - Maintainers backport changes from a development branch to release branches. diff --git a/Documentation/internals/contributing/coding-style.rst b/Documentation/internals/contributing/coding-style.rst index bec8bc102..88315aa76 100644 --- a/Documentation/internals/contributing/coding-style.rst +++ b/Documentation/internals/contributing/coding-style.rst @@ -645,5 +645,5 @@ Python ------ When introducing new Python code, try to follow Python's `PEP 8 -<https://www.python.org/dev/peps/pep-0008/>`__ style. Consider running the -``pep8`` or ``flake8`` tool against your code to find issues. +<https://peps.python.org/pep-0008/>`__ style. Consider running the +``pycodestyle`` or ``flake8`` tool against your code to find issues. diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index 1c44fbb57..ab34741ef 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -351,9 +351,9 @@ __ http://www.sphinx-doc.org/en/stable/config.html#confval-man_pages Writing Style ------------- -Follow these guidelines to ensure readability and consistency of the Open -vSwitch documentation. These guidelines are based on the `/*IBM Style Guide/* -<https://www.ibm.com/developerworks/library/styleguidelines/>`__. +Follow these guidelines to ensure readability and consistency of the OVN +documentation. These guidelines are based on the `IBM Style Guide +<https://www.ibm.com/docs/en/ibm-style>`__. - Use standard US English @@ -417,10 +417,6 @@ Helpful Tools There are a number of tools, online and offline, which can be used to preview documents are you edit them: -- `rst.ninjs.org <http://rst.ninjs.org/>`__ - - An online rST editor/previewer - - `ReText <https://github.com/retext-project/retext>`__ A simple but powerful editor for Markdown and reStructuredText. ReText is diff --git a/Documentation/internals/contributing/inclusive-language.rst b/Documentation/internals/contributing/inclusive-language.rst index 65e9c4fbd..051ba1744 100644 --- a/Documentation/internals/contributing/inclusive-language.rst +++ b/Documentation/internals/contributing/inclusive-language.rst @@ -42,15 +42,15 @@ the project. Word List --------- -The intent of this document is to formally document the acceptance of a -inclusive word list by OVN. Accordingly, this document specifies -use of the use the `Inclusive Naming Word List +The intent of this document is to formally document OVN's adoption of an +inclusive word list. Accordingly, this document specifies use of the +`Inclusive Naming Word List <https://inclusivenaming.org/word-lists/>`__ v1.0 (the word list) for OVN. -The adoption of the word list intended that this act as a guide for +The word list acts as a guide for developers creating patches to the OVN repository, including both -source code and documentation. And to aid maintainers in their role of +source code and documentation. It also aids maintainers in their role of shepherding changes into the repository. Further steps to align usage of language in OVN, including clarification diff --git a/Documentation/internals/contributing/submitting-patches.rst b/Documentation/internals/contributing/submitting-patches.rst index beede72a2..abeb3e9d0 100644 --- a/Documentation/internals/contributing/submitting-patches.rst +++ b/Documentation/internals/contributing/submitting-patches.rst @@ -25,7 +25,7 @@ Submitting Patches ================== -Send changes to OVN as patches to [email protected]. One patch per +Send changes to OVN as patches to [email protected]. Send one patch per email. More details are included below. If you are using Git, then `git format-patch` takes care of most of the -- 2.55.0 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
