docs: Tweaks to code of conduct

- Replace unicode quotes with ascii, since Sphinx will automatically
  translate these for us
- Move the header to the root document
- Use an admonition instead of a header for the attribution section

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane
2020-05-30 12:11:58 +01:00
parent 6b480c97b2
commit fa5fadc3f3
2 changed files with 11 additions and 12 deletions

View File

@@ -1,3 +1,7 @@
======================
Sphinx Code of Conduct
======================
Like the technical community as a whole, the Sphinx team and community is made
up of volunteers from all over the world.
Diversity is a strength, but it can also lead to communication issues and
@@ -25,7 +29,7 @@ adhere to.
Not all of us will agree all the time, but disagreement is no excuse for poor
behavior and poor manners. We might all experience some frustration now and
then, but we cannot allow that frustration to turn into a personal attack.
Its important to remember that a community where people feel uncomfortable or
It's important to remember that a community where people feel uncomfortable or
threatened is not a productive one. Members of the Sphinx community should be
respectful when dealing with other members as well as with people outside the
Sphinx community.
@@ -57,20 +61,18 @@ adhere to.
* **When we disagree, try to understand why.**
Disagreements, both social and technical, happen all the time and Sphinx is no
exception. It is important that we resolve disagreements and differing views
constructively. Remember that were different. Different people have different
constructively. Remember that we're different. Different people have different
perspectives on issues. Being unable to understand why someone holds a
viewpoint doesnt mean that theyre wrong. Dont forget that it is human to
err and blaming each other doesnt get us anywhere. Instead, focus on helping
viewpoint doesn't mean that they're wrong. Don't forget that it is human to
err and blaming each other doesn't get us anywhere. Instead, focus on helping
to resolve issues and learning from mistakes.
This isnt an exhaustive list of things that you cant do.
Rather, take it in the spirit in which its intended - a guide to make it easier
This isn't an exhaustive list of things that you can't do.
Rather, take it in the spirit in which it's intended - a guide to make it easier
to enrich all of us and the technical communities in which we participate.
This code of conduct applies to all spaces of the Sphinx community.
Attribution
-----------
.. rubric:: Attribution
Original text courtesy of the Speak Up! project:
http://web.archive.org/web/20141109123859/http://speakup.io/coc.html.

View File

@@ -2,7 +2,4 @@
.. _code_of_conduct:
Sphinx Code of Conduct
======================
.. include:: ../../CODE_OF_CONDUCT