Commit Graph

7 Commits

Author SHA1 Message Date
Stephen Finucane
227bbf6559 docs: Expand organization document
Provide some guidance on how one can become a core developer and explain
the different types of contribution one can make.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:13:31 +01:00
Stephen Finucane
fa5fadc3f3 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>
2020-06-02 12:10:24 +01:00
Stephen Finucane
6b480c97b2 docs: Rework contributing document, re-add CONTRIBUTING
Reorder this to flow a little better and re-add the CONTRIBUTING
document, which now simply points to the main documentation.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:10:21 +01:00
Stephen Finucane
d3021f644f docs: Add contributing document
This completes the migration from the CONTRIBUTING document to the new
in-tree contributing guide. The CONTRIBUTING document itself is
temporarily removed so that git will correctly mark the document as
having been moved. A future change will re-add this document as well as
rework the new contributing document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:08:34 +01:00
Stephen Finucane
a33483f154 docs: Add release process document
This is based on content extracted from the CONTRIBUTING document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00
Stephen Finucane
6b19678253 docs: Add organization overview
Provide an introduction to how the Sphinx team is organized. This will
be expanded upon in a future change.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00
Stephen Finucane
6a5921d7b2 docs: Add "project internals" guide
This is modelled off Django's guide of the same name [1]. In summary,
this will contain most of the information previously found in the
CONTRIBUTING document. For now, we move just the code of conduct and
authors documents.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00