Skip to content

Commit

Permalink
Documentation: Add section on inclusive language.
Browse files Browse the repository at this point in the history
As a community we should strive to be inclusive.
As such it seems appropriate to adopt an word list,
to help guide the use of inclusive language.

This patch proposes use of the Inclusive Naming Word List v1.0.

Link: https://inclusivenaming.org/word-lists/
Signed-off-by: Simon Horman <horms@ovn.org>
Acked-by: Eelco Chaudron <echaudro@redhat.com>
Acked-by: Aaron Conole <aconole@redhat.com>
  • Loading branch information
Simon Horman committed Dec 21, 2023
1 parent de4cccf commit df5e5cf
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ DOC_SOURCE = \
Documentation/internals/security.rst \
Documentation/internals/contributing/index.rst \
Documentation/internals/contributing/backporting-patches.rst \
Documentation/internals/contributing/inclusive-language.rst \
Documentation/internals/contributing/coding-style.rst \
Documentation/internals/contributing/coding-style-windows.rst \
Documentation/internals/contributing/documentation-style.rst \
Expand Down
1 change: 1 addition & 0 deletions Documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Contributing

- :doc:`internals/contributing/submitting-patches`
- :doc:`internals/contributing/backporting-patches`
- :doc:`internals/contributing/inclusive-language`
- :doc:`internals/contributing/coding-style`
- :doc:`internals/contributing/coding-style-windows`

Expand Down
58 changes: 58 additions & 0 deletions Documentation/internals/contributing/inclusive-language.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.

Convention for heading levels in Open vSwitch documentation:

======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4

Avoid deeper levels because they do not render well.

==================
Inclusive Language
==================

In order to help facilitate an inclusive environment in the Open vSwitch
community we recognise the role of language in framing our
communication with each other. It is important that terms that
may exclude people through racial, cultural or other bias, are avoided
as they may make people feel excluded.

We recognise that this is subjective, and to some extent is a journey.
But we also recognise that we cannot begin that journey without taking
positive action. To this end Open vSwitch is adopting the practice
of an inclusive word list, which helps to guide the use of language within
the project.

.. _word list:

Word List
---------

The intent of this document is to formally document the acceptance of a
inclusive word list by Open vSwitch. Accordingly, this document specifies
use of the use the `Inclusive Naming Word List
<https://inclusivenaming.org/word-lists/>`__ v1.0 (the word list) for Open
vSwitch.

The adoption of the word list intended that this act as a guide for
developers creating patches to the Open vSwitch repository, including both
source code and documentation. And to aid maintainers in their role of
shepherding changes into the repository.

Further steps to align usage of language in Open vSwitch, including
clarification of application of the word list, to new and existing work,
may follow.
1 change: 1 addition & 0 deletions Documentation/internals/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@ The below guides provide information on contributing to Open vSwitch itself.
coding-style
coding-style-windows
documentation-style
inclusive-language
libopenvswitch-abi

0 comments on commit df5e5cf

Please sign in to comment.