diff mbox series

[3/8] Convert code-of-conduct to rst

Message ID 20200911124009.3760032-4-george.dunlap@citrix.com
State New
Headers show
Series Finding a home for the Code of Conduct | expand

Commit Message

George Dunlap Sept. 11, 2020, 12:40 p.m. UTC
Underline section titles.

Convert links to RST-style links.  NB that the Communication Guide
link won't work ATM; this will be fixed when we convert that document
to RST.

Adjust the formatting for the list so that it's converted properly.

A couple of clean-ups:

* Expand the label for communication guidance, and convert the link to
the project governance to a named reference rather than an "embedded"
URI.

* Move all hyperlink targets to the bottom of the article, and put
  them in the order they're linked.

No changes to the text.

Signed-off-by: George Dunlap <george.dunlap@citrix.com>
---
 ...code-of-conduct.md => code-of-conduct.rst} | 39 ++++++++++++-------
 source/conf.py                                |  2 +-
 source/index.rst                              |  1 +
 3 files changed, 27 insertions(+), 15 deletions(-)
 rename source/{code-of-conduct.md => code-of-conduct.rst} (83%)

Comments

Jürgen Groß Sept. 11, 2020, 1:39 p.m. UTC | #1
On 11.09.20 14:40, George Dunlap wrote:
> Underline section titles.
> 
> Convert links to RST-style links.  NB that the Communication Guide
> link won't work ATM; this will be fixed when we convert that document
> to RST.
> 
> Adjust the formatting for the list so that it's converted properly.
> 
> A couple of clean-ups:
> 
> * Expand the label for communication guidance, and convert the link to
> the project governance to a named reference rather than an "embedded"
> URI.
> 
> * Move all hyperlink targets to the bottom of the article, and put
>    them in the order they're linked.
> 
> No changes to the text.
> 
> Signed-off-by: George Dunlap <george.dunlap@citrix.com>
> ---
>   ...code-of-conduct.md => code-of-conduct.rst} | 39 ++++++++++++-------
>   source/conf.py                                |  2 +-
>   source/index.rst                              |  1 +
>   3 files changed, 27 insertions(+), 15 deletions(-)
>   rename source/{code-of-conduct.md => code-of-conduct.rst} (83%)
> 
> diff --git a/source/code-of-conduct.md b/source/code-of-conduct.rst
> similarity index 83%
> rename from source/code-of-conduct.md
> rename to source/code-of-conduct.rst
> index a6080cd..81efe04 100644
> --- a/source/code-of-conduct.md
> +++ b/source/code-of-conduct.rst
> @@ -1,6 +1,8 @@
> -# Xen Project Code of Conduct
> +Xen Project Code of Conduct
> +***************************
>   
> -## Our Pledge
> +Our Pledge
> +==========
>   
>   In the interest of fostering an open and welcoming environment, we as
>   contributors and maintainers pledge to make participation in our project and
> @@ -9,12 +11,13 @@ size, disability, ethnicity, sex characteristics, gender identity and
>   expression, level of experience, education, socio-economic status, nationality,
>   personal appearance, race, religion, or sexual identity and orientation.
>   
> -## Our Standards
> +Our Standards
> +=============
>   
>   We believe that a Code of Conduct can help create a harassment-free environment,
>   but is not sufficient to create a welcoming environment on its own: guidance on
>   creating a welcoming environment, how to communicate in an effective and
> -friendly way, etc. can be found [here][guidance]].
> +friendly way, etc. can be found `here <Communication Guidance_>`_.
>   
>   Examples of unacceptable behavior by participants include:
>   
> @@ -27,7 +30,8 @@ Examples of unacceptable behavior by participants include:
>   * Other conduct which could reasonably be considered inappropriate in a
>     professional setting
>   
> -## Our Responsibilities
> +Our Responsibilities
> +====================
>   
>   Project leadership team members are responsible for clarifying the standards of
>   acceptable behavior and are expected to take appropriate and fair corrective
> @@ -39,7 +43,8 @@ contributions that are not aligned to this Code of Conduct, or to ban
>   temporarily or permanently any contributor for other behaviors that they deem
>   inappropriate, threatening, offensive, or harmful.
>   
> -## Scope
> +Scope
> +=====
>   
>   This Code of Conduct applies within all project spaces of all sub-projects,
>   and it also applies when an individual is representing the project or its
> @@ -49,7 +54,8 @@ media account, or acting as an appointed representative at an online or offline
>   event. Representation of a project may be further defined and clarified by the
>   project leadership.
>   
> -## What to do if you witness or are subject to unacceptable behavior
> +What to do if you witness or are subject to unacceptable behavior
> +=================================================================
>   
>   Instances of abusive, harassing, or otherwise unacceptable behavior may be
>   reported by contacting Conduct Team members at conduct@xenproject.org. All
> @@ -67,25 +73,30 @@ Project leadership team members who do not follow or enforce the Code of Conduct
>   in good faith may face temporary or permanent repercussions as determined by
>   other members of the project's leadership.
>   
> -## Conduct Team members
> +Conduct Team members
> +====================
> +
>   Conduct Team members are project leadership team members from any
>   sub-project. The current list of Conduct Team members is:
> +
>   * Lars Kurth <lars dot kurth at xenproject dot org>

May I suggest to add a patch removing Lars from this list?


Juergen
George Dunlap Sept. 11, 2020, 1:45 p.m. UTC | #2
> On Sep 11, 2020, at 2:39 PM, Jürgen Groß <jgross@suse.com> wrote:
> 
> On 11.09.20 14:40, George Dunlap wrote:
>> 
>> +Conduct Team members
>> +====================
>> +
>>  Conduct Team members are project leadership team members from any
>>  sub-project. The current list of Conduct Team members is:
>> +
>>  * Lars Kurth <lars dot kurth at xenproject dot org>
> 
> May I suggest to add a patch removing Lars from this list?

Yes, that would have been on my list of things to do after this.

One thing I meant to mention in my cover letter is that I think we might want at least one more person to be on this list, so it’s not just Ian and I.

 -George
diff mbox series

Patch

diff --git a/source/code-of-conduct.md b/source/code-of-conduct.rst
similarity index 83%
rename from source/code-of-conduct.md
rename to source/code-of-conduct.rst
index a6080cd..81efe04 100644
--- a/source/code-of-conduct.md
+++ b/source/code-of-conduct.rst
@@ -1,6 +1,8 @@ 
-# Xen Project Code of Conduct
+Xen Project Code of Conduct
+***************************
 
-## Our Pledge
+Our Pledge
+==========
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to make participation in our project and
@@ -9,12 +11,13 @@  size, disability, ethnicity, sex characteristics, gender identity and
 expression, level of experience, education, socio-economic status, nationality,
 personal appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+Our Standards
+=============
 
 We believe that a Code of Conduct can help create a harassment-free environment,
 but is not sufficient to create a welcoming environment on its own: guidance on
 creating a welcoming environment, how to communicate in an effective and
-friendly way, etc. can be found [here][guidance]].
+friendly way, etc. can be found `here <Communication Guidance_>`_.
 
 Examples of unacceptable behavior by participants include:
 
@@ -27,7 +30,8 @@  Examples of unacceptable behavior by participants include:
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+Our Responsibilities
+====================
 
 Project leadership team members are responsible for clarifying the standards of
 acceptable behavior and are expected to take appropriate and fair corrective
@@ -39,7 +43,8 @@  contributions that are not aligned to this Code of Conduct, or to ban
 temporarily or permanently any contributor for other behaviors that they deem
 inappropriate, threatening, offensive, or harmful.
 
-## Scope
+Scope
+=====
 
 This Code of Conduct applies within all project spaces of all sub-projects,
 and it also applies when an individual is representing the project or its
@@ -49,7 +54,8 @@  media account, or acting as an appointed representative at an online or offline
 event. Representation of a project may be further defined and clarified by the
 project leadership.
 
-## What to do if you witness or are subject to unacceptable behavior
+What to do if you witness or are subject to unacceptable behavior
+=================================================================
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting Conduct Team members at conduct@xenproject.org. All
@@ -67,25 +73,30 @@  Project leadership team members who do not follow or enforce the Code of Conduct
 in good faith may face temporary or permanent repercussions as determined by
 other members of the project's leadership.
 
-## Conduct Team members
+Conduct Team members
+====================
+
 Conduct Team members are project leadership team members from any
 sub-project. The current list of Conduct Team members is:
+
 * Lars Kurth <lars dot kurth at xenproject dot org>
 * George Dunlap <george dot dunlap at citrix dot com>
 * Ian Jackson <ian dot jackson at citrix dot com>
 
 Conduct Team members are changed by proposing a change to this document,
 posted on all sub-project lists, followed by a formal global vote as outlined
-[here]: https://xenproject.org/developers/governance/#project-decisions
+`here <Project Governance_>`_.
 
-## Attribution
+Attribution
+===========
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+This Code of Conduct is adapted from the `Contributor Covenant`_,
 version 1.4, available at
 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
-[guidance]: communication-guide.md
-
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
+
+.. _Communication Guidance: communication-guide.md
+.. _Project Governance: https://xenproject.org/developers/governance/#project-decisions
+.. _Contributor Covenant: https://www.contributor-covenant.org
diff --git a/source/conf.py b/source/conf.py
index 7b99910..85bcedb 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -49,4 +49,4 @@  html_theme = 'alabaster'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
\ No newline at end of file
+html_static_path = ['_static']
diff --git a/source/index.rst b/source/index.rst
index 99cb386..079c02e 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -10,6 +10,7 @@  Welcome to XenProject Governance's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   code-of-conduct
 
 Indices and tables
 ==================