mbox series

[0/8] Finding a home for the Code of Conduct

Message ID 20200911124009.3760032-1-george.dunlap@citrix.com (mailing list archive)
Headers show
Series Finding a home for the Code of Conduct | expand

Message

George Dunlap Sept. 11, 2020, 12:40 p.m. UTC
The Code of Conduct has been approved [1]; now we need to find it a
home.  Since we've started using sphinx for the hypervisor documents,
I propose doing the same for the project-wide governance documents, starting
with the Code of Conduct.

This series takes Lars' code of conduct tree, written as individual MD
files, and puts them into the sphinx documentation system.  After this
series, if you run "make html" in the top-level directory, you'll get
the generated sphinx documentation in the build/ directory.

The finalized Code of Conduct documentation can be found at:

https://xenbits.xen.org/git-http/people/gdunlap/governance.git

This series can be found on the branch out/move-to-sphinx/v1

And a rendered version of the governance can be found here:

https://xenbits.xenproject.org/people/gdunlap/governance/

If there are no objections to this setup, I propose the following URL
as a long-term home:

https://xenbits.xenproject.org/governance

And also moving both the main governance doc [2] and the security
policy [3] into that system, to make it easier to update.

Thoughts?

[1] https://marc.info/?i=CB503BA1-979C-42E5-86C6-AFAB10C738DF@citrix.com%3E

[2] https://xenproject.org/developers/governance/

[3] https://xenproject.org/developers/security-policy/

CC: Ian Jackson <ian.jackson@citrix.com>
CC: Wei Liu <wei.liu2@citrix.com>
CC: Andrew Cooper <andrew.cooper3@citrix.com>
CC: Jan Beulich <jbeulich@suse.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Julien Grall <julien.grall@arm.com>
CC: Paul Durrant <paul@xenproject.org>

George Dunlap (8):
  Add basic sphinx structure
  Move docs into source directory, rename to rst
  Convert code-of-conduct to rst
  Convert communication-guide.md to rst
  Convert code-review-guide.md to rst
  Convert communication-practice.md to RST
  Convert resolving-disagreement.md to rst
  Clean up index page

 Makefile                                      |  20 ++
 .../code-of-conduct.rst                       |  39 ++-
 .../code-review-guide.rst                     | 154 ++++++----
 .../communication-guide.rst                   |  27 +-
 .../communication-practice.rst                | 289 +++++++++++-------
 source/conf.py                                |  54 ++++
 source/index.rst                              |  36 +++
 .../resolving-disagreement.rst                | 109 ++++---
 8 files changed, 495 insertions(+), 233 deletions(-)
 create mode 100644 Makefile
 rename code-of-conduct.md => source/code-of-conduct.rst (83%)
 rename code-review-guide.md => source/code-review-guide.rst (79%)
 rename communication-guide.md => source/communication-guide.rst (82%)
 rename communication-practice.md => source/communication-practice.rst (75%)
 create mode 100644 source/conf.py
 create mode 100644 source/index.rst
 rename resolving-disagreement.md => source/resolving-disagreement.rst (72%)

Comments

Stefano Stabellini Sept. 11, 2020, 4:50 p.m. UTC | #1
On Fri, 11 Sep 2020, George Dunlap wrote:
> The Code of Conduct has been approved [1]; now we need to find it a
> home.  Since we've started using sphinx for the hypervisor documents,
> I propose doing the same for the project-wide governance documents, starting
> with the Code of Conduct.
> 
> This series takes Lars' code of conduct tree, written as individual MD
> files, and puts them into the sphinx documentation system.  After this
> series, if you run "make html" in the top-level directory, you'll get
> the generated sphinx documentation in the build/ directory.
> 
> The finalized Code of Conduct documentation can be found at:
> 
> https://xenbits.xen.org/git-http/people/gdunlap/governance.git
> 
> This series can be found on the branch out/move-to-sphinx/v1
> 
> And a rendered version of the governance can be found here:
> 
> https://xenbits.xenproject.org/people/gdunlap/governance/
> 
> If there are no objections to this setup, I propose the following URL
> as a long-term home:
> 
> https://xenbits.xenproject.org/governance
> 
> And also moving both the main governance doc [2] and the security
> policy [3] into that system, to make it easier to update.
> 
> Thoughts?

Sounds great.

I'd suggest to also move the governance.git repository to a more
"official" location on xenbits.
George Dunlap Sept. 14, 2020, 9:41 a.m. UTC | #2
> On Sep 11, 2020, at 5:50 PM, Stefano Stabellini <sstabellini@kernel.org> wrote:
> 
> On Fri, 11 Sep 2020, George Dunlap wrote:
>> The Code of Conduct has been approved [1]; now we need to find it a
>> home.  Since we've started using sphinx for the hypervisor documents,
>> I propose doing the same for the project-wide governance documents, starting
>> with the Code of Conduct.
>> 
>> This series takes Lars' code of conduct tree, written as individual MD
>> files, and puts them into the sphinx documentation system.  After this
>> series, if you run "make html" in the top-level directory, you'll get
>> the generated sphinx documentation in the build/ directory.
>> 
>> The finalized Code of Conduct documentation can be found at:
>> 
>> https://xenbits.xen.org/git-http/people/gdunlap/governance.git
>> 
>> This series can be found on the branch out/move-to-sphinx/v1
>> 
>> And a rendered version of the governance can be found here:
>> 
>> https://xenbits.xenproject.org/people/gdunlap/governance/
>> 
>> If there are no objections to this setup, I propose the following URL
>> as a long-term home:
>> 
>> https://xenbits.xenproject.org/governance
>> 
>> And also moving both the main governance doc [2] and the security
>> policy [3] into that system, to make it easier to update.
>> 
>> Thoughts?
> 
> Sounds great.
> 
> I'd suggest to also move the governance.git repository to a more
> "official" location on xenbits.

Yes of course. :-)  The goal was first to get a draft up as quickly as possible for people to look at.

 -George