Merge branch 'usma' of https://github.com/Unique-Usman/docs-community into usma

Author: Unique-Usman

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: monthly
+    assignees:
+      - "ezio-melotti"
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/workflows/documentation-links.yml

@@ -10,7 +10,9 @@ permissions:
 jobs:
   documentation-links:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - uses: readthedocs/actions/preview@v1
         with:
           project-slug: "docs-community"
+          single-version: "true"

.github/workflows/lint.yaml

@@ -8,10 +8,11 @@ permissions:
 jobs:
   lint:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
       - uses: pre-commit/[email protected]

.github/workflows/test-build.yaml

@@ -6,13 +6,14 @@ jobs:
   build-sphinx:
     name: Build with Sphinx
     runs-on: ubuntu-latest
+    timeout-minutes: 10
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python 3
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
           cache: "pip"

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.12.1
+    rev: 24.1.1
     hooks:
       - id: black
 
@@ -18,5 +18,10 @@ repos:
     hooks:
       - id: sphinx-lint
 
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+
 ci:
   autoupdate_schedule: quarterly

README.md

@@ -1,11 +1,27 @@
 # Python Documentation Community
 
 [![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/en/latest/?badge=latest)
-
-The Python Documentation Working Group (Docs WG) was created and accepted by the **Python Steering Council** in 2021
-to help bootstrap a larger documentation team and community.
-
-This repo serves as documentation for the Docs WG, which is funny, in a recursive kind of way.
+![Discourse](https://img.shields.io/badge/discourse-chat-brightgreen)
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="pep732-circles-dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="pep732-circles-light.png">
+  <img
+   alt="Three concentric circles. At the centre: Documentation Editorial Board, trusted group. Around this: Documentation Working Group, volunteers who contribute to the docs. Finally, the outer circle is the world, includes readers of the documentation."
+   src="pep732-circles-light.png">
+</picture>
+
+1. Editorial Board (Approved in 2023 by Steering Council and described in
+   [PEP 732](https://peps.python.org/pep-0732/))<br>
+   Referred to as Editorial Board or EB<br>
+   Repo: [python/editorial-board](https://github.com/python/editorial-board)
+2. Documentation Community Group (Working Group created in 2021 by the Python
+   Steering Council)<br>
+   Referred to as the Documentation Community or docs-community<br>
+   Repo: [python/docs-community](https://github.com/python/docs-community)
+3. Users of Python Documentation
+
+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/).
 
@@ -31,6 +47,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

docs/community/community-guide.md

@@ -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
-- python_docs_theme
-- discourse channel
 
+- [devguide](https://devguide.python.org)
+- [docs](https://docs.python.org)
+- python_docs_theme
+- [discourse category](https://discuss.python.org/c/documentation/26)
+- Discord server
 
 ### 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.
-2. The [Discourse forum](http://discuss.python.org/) for general discussions, support
+
+1. GitHub issues for specific discussions related to changing a repository's content.
+2. The [Discourse forum](https://discuss.python.org/c/documentation/26) for general discussions, support
 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"](https://github.com/python/cpython/labels/docs).

docs/community/index.rst

@@ -18,4 +18,3 @@ The Documentation Community Team has a Code of Conduct
     contributing
     community-guide
     skills
-    team

docs/community/skills.md

@@ -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.

docs/community/team.rst

@@ -1,3 +1,7 @@
+:orphan:
+
+.. This page is retained solely for existing links.
+
 .. _doc_team:
 
 ==================