Merge branch 'main' of github.com:conda-forge/conda-forge.github.io into Improve-ReadMe

Author: jaimergp

.ci_scripts/display_linkcheck.py

@@ -0,0 +1,45 @@
+import argparse
+import json
+from collections import defaultdict
+from termcolor import colored
+
+status_colors = dict(
+    broken='red',
+    redirected='yellow',
+    working='green',
+    ignored='white',
+    unchecked='white',
+ )
+
+def create_parser():
+    parser = argparse.ArgumentParser('display_linkcheck')
+    parser.add_argument('linkcheck_json')
+    return parser
+
+
+def main():
+    parser = create_parser()
+    args = parser.parse_args()
+    buffer = defaultdict(list)
+    with open(args.linkcheck_json) as fh:
+        for line in fh:
+            data = json.loads(line)
+            buffer[data['status']].append(data)
+   
+    for status, color in status_colors.items():
+        if status not in buffer:
+            continue
+        for data in buffer[status]:
+            
+            print_tokens = [
+                colored(f'[{data["status"]}]', color),
+                colored(data['uri'], 'magenta'),
+                f'{data["filename"]}:{data["lineno"]}',
+            ]
+            if data['info'] != '':
+                print_tokens.append(f'({data["info"]})')
+
+            print(*print_tokens)
+
+if __name__ == '__main__':
+    main()

.ci_scripts/environment.yml

@@ -16,8 +16,4 @@ dependencies:
   - python-dateutil
   - pip
   - python-rapidjson
-  # uncomment to restore search
-  # - elm
-  # - nodejs
-  #  - pip: 
-  #    - sphinxcontrib-newsfeed # this helps when using vscode locally
+  - termcolor

.ci_scripts/update_docs

@@ -14,13 +14,7 @@ popd
 
 python .ci_scripts/generate_html.py
 
-# rebuild elm
-# uncomment to restore search
-# npm install uglify-js --global
-# ./elm-compile.xsh
-
-# build docs into docs/; preserve old README file
-mv docs/README docs-README
+# build docs into docs
 rm -rf docs/
 
 python .ci_scripts/generate_cfep_index.py
@@ -30,9 +24,14 @@ pushd src
 # -W --keep-going: list all warnings but fail build in case there are any
 # -n: check validity of all links
 make html SPHINXOPTS="-W --keep-going -n"
-make linkcheck
+linkcheck_failed=0
+make linkcheck > /dev/null || linkcheck_failed=1
+python ../.ci_scripts/display_linkcheck.py _build/linkcheck/output.json
+
+if [[ "${GHREF}" != "refs/heads/main" ]]; then
+  test "$linkcheck_failed" -eq 0
+fi
+
 mv _build/html ../docs
 rm -rf _build
 popd
-
-mv docs-README docs/README

.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +1,7 @@
 blank_issues_enabled: true
 contact_links:
-  - name: Conda-forge gitter chat
-    url: https://gitter.im/conda-forge/conda-forge.github.io
+  - name: Conda-forge Element chatroom
+    url: https://app.element.io/#/room/#conda-forge:matrix.org
     about: Chat to us about conda-forge and ask general questions.
   - name: Conda-forge documentation
     url: https://conda-forge.org/docs/

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,4 @@
-<!--
-Thank you for pull request!
-
-Please note that the `docs` subdir is generated from the sphinx sources in `src`, changes 
-to `.html` files will only be effective if applied to the respective `.rst`.
--->
-
 PR Checklist:
 
-- [ ] make all edits to the docs in the `src` directory, not in `docs` or in the html files
 - [ ] note any issues closed by this PR with [closing keywords](https://help.github.com/articles/closing-issues-using-keywords)
 - [ ] put any other relevant information below

.github/workflows/deploy.yml

@@ -29,6 +29,8 @@ jobs:
         shell: bash -l {0}
         run: |
           source ./.ci_scripts/update_docs
+        env:
+          GHREF: ${{ github.ref }}
 
       - name: deploy
         if: github.ref == 'refs/heads/main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')

.github/workflows/docs_linter.yml

@@ -0,0 +1,46 @@
+name: Create PR for meeting notes
+
+on:
+  workflow_dispatch:
+    inputs:
+      date:
+        description: |
+          Date of the meeting notes. MUST be understood by `date --date`.
+          Common examples are "now", "tomorrow", "next Wednesday", "2023-03-01"...
+          See https://www.gnu.org/software/coreutils/manual/html_node/Date-input-formats.html for full details.
+        required: false
+        default: "now"
+        type: string
+  pull_request:
+    types:
+      - labeled
+
+permissions:
+  contents: write
+  pull-requests: write
+# You need to enable 'Allow GitHub Actions to create and approve pull requests'
+# in your Actions Settings too
+
+jobs:
+  create:
+    if: github.event_name != 'pull_request'
+    uses: Quansight-Labs/hackmd-meeting-notes-action/.github/workflows/create-meeting-notes-pr.yml@main
+    with:
+      date: ${{ inputs.date || 'now' }}
+      template_path: misc/DEV_MEETING_TEMPLATE.md
+      output_path: src/orga/minutes/%Y-%m-%d.md
+      hackmd_team: conda-forge
+      force_push: true
+      pr_body: |
+        New meeting notes available at ${env.hackmd_doc_url}.
+
+        Once done with the meeting, sync the note back to the repository by adding the `sync-hackmd-notes` label.
+    secrets:
+      HACKMD_TOKEN: ${{ secrets.HACKMD_TOKEN }}
+  sync:
+    if: github.event.label.name == 'sync-hackmd-notes'
+    uses: Quansight-Labs/hackmd-meeting-notes-action/.github/workflows/sync-meeting-notes-pr.yml@main
+    with:
+      pr_number: ${{ github.event.number }}
+    secrets:
+      HACKMD_TOKEN: ${{ secrets.HACKMD_TOKEN }}

.github/workflows/meeting-notes.yml

@@ -49,16 +49,11 @@
                 </a>
             </div>
 
-            <div class="collapse navbar-collapse navbar-right navbar-main-collapse">
+            <div class="collapse navbar-collapse navbar-main-collapse">
                 <ul class="nav navbar-nav">
                     <li>
                         <a class="page-scroll" href="https://conda-forge.org/#about">About</a>
                     </li>
-                    <!-- Uncomment to restore search
-                    <li>
-                        <a href="search.html">Search</a>
-                    </li>
-                    -->
                     <li>
                         <a href="https://conda-forge.org/docs">Docs</a>
                     </li>
@@ -84,6 +79,13 @@
                         <a href="https://numfocus.salsalabs.org/donate-to-conda-forge/index.html">Donate!</a>
                     </li>
                 </ul>
+                <ul class="nav navbar-nav navbar-right">
+                    <li>
+                        <a href="https://github.com/conda-forge">
+                            <i class="fa fa-github"></i>
+                        </a>
+                    </li>
+                </ul>
             </div>
             <!-- /.navbar-collapse -->
         </div>

404.html

@@ -26,12 +26,19 @@ If you have questions or need help, please check out our documentation for a [li
 4.  Make and commit your changes.
 5.  Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) to the main repository proposing your changes.
 
-**Note: "All changes must be made in the `/src` folder and NOT in the `/docs` folder. Html files in the ./docs folder are auto generated "**
-
 ## conda-forge dev meetings
 
-We hold biweekly meetings every second Wednesday from 17:00-18:00 (UTC). Feel free to stop by with the help of this [Google Calendar invite](https://calendar.google.com/calendar/u/0/r/eventedit/copy/Z2lraDk2a205cGUxdDkxYmNybXQxMGIxMGtfMjAxOTA3MjRUMTcwMDAwWiBzY29wYXR6QG0/c2hsb2thcHJpbmNlc3MxMDFAZ21haWwuY29t?scp=ALL&sf=true).
+We hold biweekly meetings every second Wednesday from 17:00-18:00 (UTC). Feel free to stop by!
+Up-to-date invites are always available in the [conda.org community calendar](https://conda.org/community/calendar). Look for the `[conda-forge] core meeting` events!
 
 Our [meeting notes](https://conda-forge.org/docs/orga/minutes/00_intro.html) record important points discussed during the meetings and serve as a record for upcoming meetings. We make use of [HackMd](https://hackmd.io/) and a [template](https://github.com/conda-forge/conda-forge.github.io/blob/main/misc/DEV_MEETING_TEMPLATE.md) to create the meeting notes.
 
+We use a Github Actions [workflow][gha-workflow] to create an automated PR with the meeting notes
+template for each session, which is automatically published to our HackMD team account. During the
+meeting, attendees will edit the HackMD document. After the meeting, the document is saved and the
+PR is synced with the changes by adding the `sync-hackmd-notes` label. Once satisfied, the PR is
+merged and the website will be updated with the new meeting notes.
+
 We encourage contributors to join the meetings and learn more about and from the community.
+
+[gha-workflow]: https://github.com/conda-forge/conda-forge.github.io/actions/workflows/meeting-notes.yml