forked from ovn-org/ovn
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation: Add inclusive-language documentation.
A recent series of commits to OVN made some changes to the language used in code, comments, and documentation to be more inclusive. This constitutes a follow-up that clarifies in the documentation what the policy is and where the list of words to avoid can be found. When starting this task, I found a commit to OVS [1] written by Simon Horman that added basically everything I wanted to say. With Simon's permission, I have copied the contents of that commit, changing all instances of "Open vSwitch" to "OVN". Simon is credited as a co-author on this commit. [1] openvswitch/ovs@df5e5cf4318a Signed-off-by: Mark Michelson <mmichels@redhat.com> Co-authored-by: Simon Horman <horms@ovn.org> Acked-by: Simon Horman <horms@ovn.org> Signed-off-by: Mark Michelson <mmichels@redhat.com>
- Loading branch information
Showing
4 changed files
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
Documentation/internals/contributing/inclusive-language.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
.. | ||
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 OVN 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 OVN | ||
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 OVN 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 OVN. Accordingly, this document specifies | ||
use of the use 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 | ||
developers creating patches to the OVN 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 OVN, including clarification | ||
of application of the word list, to new and existing work, may follow. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters