Add people section and support for automatic contributors list update (#554)

* Configure all-contributors

Revert to minimal all-contributors config

* Use contributors-readme-action

* Use default 6 columns per row

* Make logos the same size as the dark version

* Add funders and leadership sections

* Schedule job to run monthly or on manual trigger

* Update workflow names

* Use custom commit message

* Set logos to have consistent height 150px

* Set 5 columns per row in contributors table

* Use custom contributors CSS class for table cells

* Add contributors manually

* Set contributors table width to 100%

* Remove `all-contributors`-relevant changes

* Allow for non-github users to be added to contributors table

* Add docs on updating contributors list

* Rephrase workflow description

* Add collaborations

* Apply suggestions from code review

Co-authored-by: Niko Sirmpilatze <niko.sirbiladze@gmail.com>

* Move People to section top

* Separate manually added gh users

* Simplify syntax for manually adding non-gh contributors

* Simplify instructions for manually adding non-gh contributors

* Correct wording from "collaborations" to "collaborators"

* Remove cols_per_row config

* Update instructions for adding gh contributors

---------

Co-authored-by: Niko Sirmpilatze <niko.sirbiladze@gmail.com>

Author: lochhh

.github/workflows/test_and_deploy.yml

@@ -1,4 +1,4 @@
-name: tests
+name: Tests
 
 on:
   push:

.github/workflows/update_contributors_list.yml

@@ -0,0 +1,27 @@
+name: Contributors
+
+# Update the contributors list in the documentation monthly
+# on the default branch main using the Contributors-Readme-Action GitHub Action.
+# As the branch is protected, the action will create a pull request.
+# Alternatively, the action can be triggered manually using the workflow_dispatch event.
+on:
+  schedule:
+    - cron: '0 0 1 * *' # Runs at midnight on the first day of every month
+  workflow_dispatch:
+
+jobs:
+  update_contributors_list:
+    name: Update Contributors List
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Contribute List
+        uses: akhilmhdh/contributors-readme-action@v2.3.10
+        with:
+          readme_path: docs/source/community/people.md
+          commit_message: 'Update contributors list'
+          pr_title_on_protected: 'Contributors-Readme-Action: Update contributors list'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -298,6 +298,38 @@ For example, to reference the {meth}`xarray.Dataset.update` method, use:
 :::
 ::::
 
+### Updating the contributors list
+The [contributors list](target-contributors) is automatically updated on the first day of each month by a GitHub actions workflow (`.github/workflows/update_contributors_list.yml`).
+It uses the [Contributors-Readme-Action](https://github.com/marketplace/actions/contribute-list) to generate the list of contributors based on the commits to the repository.
+
+It is also possible to manually add other contributors who have not contributed code to the repository, but have contributed in other ways (e.g. by providing sample data, or by actively participating in discussions).
+The way to add them differs depending on whether they are GitHub users or not.
+
+::::{tab-set}
+:::{tab-item} GitHub users
+To add a contributor who has a GitHub account, locate the section marked with `<!-- MANUAL: OTHER GITHUB CONTRIBUTORS -->` in `docs/source/community/people.md`.
+
+Next, add their GitHub username (e.g. `newcontributor`) to the `<!-- readme: -start -->` and `<!-- readme: -end -->` lines as follows:
+```html
+<!-- readme: githubUser1,githubUser2,newcontributor -start -->
+existing content...
+<!-- readme: githubUser1,githubUser2,newcontributor -end -->
+```
+
+The aforementioned GitHub actions workflow will then automatically update the contributors list with `newcontributor`'s GitHub profile picture, name, and link to their GitHub profile.
+:::
+
+:::{tab-item} Non-GitHub users
+To add a contributor who does not have a GitHub account, locate the section marked with `<!-- MANUAL: OTHER NON-GITHUB CONTRIBUTORS -->` in `docs/source/community/people.md`.
+
+Next, add a row containing the contributor's image, name, and link to their website to the existing `list-table` as follows:
+```markdown
+*   - existing content...
+*   - [![newcontributor](https://newcontributor.image.jpg) <br /> <sub><b>New Contributor</b></sub>](https://newcontributor.website.com)
+```
+:::
+::::
+
 ### Building the documentation locally
 We recommend that you build and view the documentation website locally, before you push your proposed changes.
 

docs/source/_static/css/custom.css

@@ -1,41 +1,55 @@
 html[data-theme=dark] {
-    --pst-color-primary: #04B46D;
-    --pst-color-link: var(--pst-color-primary);
-  }
+  --pst-color-primary: #04B46D;
+  --pst-color-link: var(--pst-color-primary);
+}
 
 html[data-theme=light] {
   --pst-color-primary: #03A062;
   --pst-color-link: var(--pst-color-primary);
 }
 
 body .bd-article-container {
-max-width: 100em !important;
+  max-width: 100em !important;
 }
 
 .col {
-flex: 0 0 50%;
-max-width: 50%;
+  flex: 0 0 50%;
+  max-width: 50%;
 }
 
 .img-sponsor {
-height: 50px;
-padding-top: 5px;
-padding-right: 5px;
-padding-bottom: 5px;
-padding-left: 5px;
+  height: 50px;
+  padding: 5px;
+}
+
+.img-sponsor-large {
+  height: 10vh;
+  padding: 5px;
 }
 
 .things-in-a-row {
-display: flex;
-flex-wrap: wrap;
-justify-content: space-between;
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: space-between;
+}
+
+.contributors-table table {
+  width: 100%;
+}
+
+.contributors-table td{
+  padding: 2px;
+  min-width: 90px;
+  vertical-align: top;
+  text-align: center;
 }
 
 /* Disable decoration for all but movement backrefs */
 a[class^="sphx-glr-backref-module-"],
 a[class^="sphx-glr-backref-type-"] {
   text-decoration: none;
 }
+
 a[class^="sphx-glr-backref-module-movement"] {
   text-decoration: underline;
 }

docs/source/_static/dark-logo-gatsby.png

@@ -0,0 +1,21 @@
+document.addEventListener('DOMContentLoaded', () => {
+    const contributorsDiv = document.querySelector('.contributors-table');
+    const contributorsTable = document.createElement('table');
+    const tbody = document.createElement('tbody');
+    // Get all <td> elements
+    const allContributors = Array.from(contributorsDiv.querySelectorAll('td'));
+    const rows = [];
+    while (allContributors.length) {
+        const row = allContributors.splice(0, 5); // 5 columns per row
+        rows.push(row);
+    }
+    rows.forEach(row => {
+        const tr = document.createElement('tr');
+        row.forEach(td => tr.appendChild(td));
+        tbody.appendChild(tr);
+    });
+    // Replace existing content with the new table
+    contributorsDiv.innerHTML = '';
+    contributorsTable.appendChild(tbody);
+    contributorsDiv.appendChild(contributorsTable);
+});