Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and add editorial board page #103

Merged
merged 12 commits into from
Feb 6, 2024
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Python Documentation Community

[![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/en/latest/?badge=latest)
![Discourse](https://img.shields.io/badge/discourse-chat-brightgreen)

![pep-0732-concentric.drawio.svg](pep-0732-concentric.drawio.svg)

Expand All @@ -14,7 +15,7 @@
Repo: [python/docs-community](https://github.com/python/docs-community)
3. Users of Python Documentation

This repo serves as documentation for the docs-community.
This repo serves as documentation for the Documentation Community Group.

For example, to find out more about us and what we do, [read the docs](https://docs-community.readthedocs.io/en/latest/).

Expand All @@ -40,6 +41,7 @@ For example, to find out more about us and what we do, [read the docs](https://d
```console
python -m pip install -r requirements.txt
```

5. Build the docs, open them in your browser and update whenever changes are made

```console
Expand Down
13 changes: 9 additions & 4 deletions docs/community/community-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,25 @@ team!

There are a few resources that are particularly useful for team members. Here's
a quick list to get you started.
- devguide
- docs

- [devguide](https://devguide.python.org)
- [docs](https://docs.python.org)
- python_docs_theme
- discourse channel
willingc marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- python_docs_theme
- discourse channel
- [Python Docs Sphinx Theme](https://github.com/python/python-docs-theme)
- [Discourse category](https://discuss.python.org/c/documentation/26)


- discord channel
willingc marked this conversation as resolved.
Show resolved Hide resolved

### General information about communication channels

We are trying to organize our discussions in order to help both contributors and
maintainers find and choose the right communication channels and have a positive experience :-)

In this respect, we are using:
1. [BPO](https://bugs.python.org) and GitHub issues for specific discussions related to changing a repository's content. This is determined by doc project.

1. GitHub issues for specific discussions related to changing a repository's content.
2. The [Discourse forum](http://discuss.python.org/) for general discussions, support
willingc marked this conversation as resolved.
Show resolved Hide resolved
questions, or just as a place where we can inspire each other.

## How can I help?

Read the devguide's section on documentation.
Visit the Python repo's GitHub issues and look for issues tagged with `docs`.
willingc marked this conversation as resolved.
Show resolved Hide resolved
1 change: 0 additions & 1 deletion docs/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ The Documentation Community Team has a Code of Conduct
contributing
community-guide
skills
team
17 changes: 3 additions & 14 deletions docs/community/skills.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,13 @@

The short answer to this question is: follow your interests :-)

## A few general ways to help out


### Python-specific knowledge

- **Code structure of the docs repository**
The [Python Developer's Guide documentation](https://devguide.python.org/documentation) section is a good place to start.
It's a comprehensive guide to the Python documentation and the tools we use to build it.
It's a good idea to read through the guide to get a sense of the tools and processes we use.

## A note on complexity of tasks

Depth/expertise required for certain kinds of tasks can be hard to nail down and not at
all obvious. If you'd like to make a contribution and you're not sure where to start,
a good rule of thumb is to reach out to another team member to help
you scope the work you'd like to do, and to set expectations.

## Links



## Resources for Learning

In this section, we gather some introductory materials for learning the aforementioned tools.
4 changes: 4 additions & 0 deletions docs/community/team.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:orphan:

.. This page is retained solely for existing links.

.. _doc_team:

==================
Expand Down
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
# A list of strings that are module names of Sphinx extensions
extensions = [
"sphinx_copybutton",
"sphinx.ext.intersphinx",
"myst_parser",
]

Expand All @@ -29,6 +30,13 @@
# Minimum Sphinx version as a string
needs_sphinx = "4.0"

# Intersphinx configuration
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"devguide": ("https://devguide.python.org/", None),
"pep": ("https://peps.python.org/", None),
}
intersphinx_disabled_reftypes = []

# Options for HTML output
# =======================
Expand Down
24 changes: 24 additions & 0 deletions docs/editorial-board/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _eb_index:

===============
Editorial Board
===============

The acceptance of :pep:`732` established the Python Documentation Editorial Board.

Monthly Editorial Board Meetings
================================

The Editorial Board's private meetings are held monthly on the second Monday
at 1:30pm Pacific.
After each meeting the Editorial Board will post a summary in the
`python/editorial-board repository <https://github.com/python/editorial-board>`_.

Working with the Editorial Board
================================

If you have a general documentation request or question, please use the
`Documentation category in Discourse <https://discuss.python.org/c/documentation/26>`_.

If you need Editorial Board assistance, please file an
`issue on the editorial-board repo <https://github.com/python/editorial-board/issues/new/choose>`_.
14 changes: 6 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
Python Documentation Community
==============================

The following pages contain information about the documentation workgroup,
the documentation community team and
community team, resources for community members, and workgroup practices for
governance and planning.
These pages explain the Python Documentation Community and its processes.

.. toctree::
:maxdepth: 2

workgroup/index
community/index
monthly-meeting/index
GitHub repository <https://github.com/python/docs-community>
editorial-board/index
GitHub docs-community <https://github.com/python/docs-community>
GitHub editorial-board <https://github.com/python/editorial-board>
Dev Guide <https://devguide.python.org/documentation/>
Python Docs <https://docs.python.org>

Why have this repo?
===================
Expand All @@ -28,8 +28,6 @@ needed. The repo contains:

- team meeting agendas and archives
- direction and action plans
- communication and culture of respectful teamwork
- recognitions and team celebrations

Code of Conduct
===============
Expand Down
2 changes: 1 addition & 1 deletion docs/monthly-meeting/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Monthly Reports Archive

`Current agenda <https://hackmd.io/@encukou/pydocswg1>`_

Monthly reports in reverse chronological order.
Monthly reports in chronological order.

.. toctree::
:maxdepth: 1
Expand Down
4 changes: 4 additions & 0 deletions docs/workgroup/adding-members.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:orphan:

.. This page is retained solely for existing links.

===========================================
Adding and onboarding new workgroup members
===========================================
Expand Down
4 changes: 4 additions & 0 deletions docs/workgroup/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:orphan:

.. This page is retained solely for existing links.

.. _governance-index:

==============
Expand Down
4 changes: 4 additions & 0 deletions docs/workgroup/milestones.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:orphan:

.. This page is retained solely for existing links.

=======================
Milestones and roadmaps
=======================
Expand Down
4 changes: 4 additions & 0 deletions docs/workgroup/workgroup_charter.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:orphan:

.. This page is retained solely for existing links.

===============================
CPython Documentation Workgroup
===============================
Expand Down
Loading