Merge branch 'main' into patch-19

Author: jakirkham

.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

@@ -4,18 +4,21 @@ channels:
 dependencies:
   - python=3
   - conda-smithy
-  - sphinx<3
+  - sphinx >=4.4
   - cloud_sptheme
   - sphinxcontrib-fulltoc
   - make
   - xonsh
-  - recommonmark
+  - myst-parser
   - pyyaml
   - jinja2
   - requests
   - python-dateutil
   - pip
   - python-rapidjson
+  - termcolor
   # uncomment to restore search
   # - elm
   # - nodejs
+  #  - pip: 
+  #    - sphinxcontrib-newsfeed # this helps when using vscode locally

.ci_scripts/generate_html.py

@@ -16,7 +16,7 @@
 data = {k: data[k] for k in keys}
 
 for k in data:
-    if "Logo URL" in data[k]:
+    if "Logo URL" in data[k] and data[k]["Logo URL"][0].startswith("http"):
         for i in range(5):
             try:
                 # extra header is needed for lab49

.ci_scripts/update_docs

@@ -2,9 +2,11 @@
 
 set -ex
 
+# configure bot account
+git config --global user.email "[email protected]"
+git config --global user.name "conda-forge-admin"
+
 git checkout -b new_site_content
-conda env create -f ./.ci_scripts/environment.yml
-conda activate conda-forge-docs
 
 pushd newsfeed
 pip install --no-deps .
@@ -24,27 +26,20 @@ rm -rf docs/
 python .ci_scripts/generate_cfep_index.py
 
 pushd src
-make html
+
+# -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"
+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
-
-# git diff
-
-# # Only commit the docs for commits on master.
-# if [[ $GH_REF == refs/heads/master ]] && [[ $GH_TOKEN != "" ]]; then
-#     git add -A :/
-#     git commit -m "Re-ran make.py. [ci skip]" || true
-#     git remote add pushable https://${GH_TOKEN}@github.com/conda-forge/conda-forge.github.io.git/ > /dev/null
-#
-#     # Update the remotes before pushing and check the status.
-#     # This should give us more info if the push will not be
-#     # a simple fast-forward push.
-#     git fetch --all 2> /dev/null
-#     git branch -u pushable/gh-pages
-#     git status
-#     git push pushable new_site_content:gh-pages
-#     # 2> /dev/null
-# fi

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Conda-forge gitter chat
+    url: https://gitter.im/conda-forge/conda-forge.github.io
+    about: Chat to us about conda-forge and ask general questions.
+  - name: Conda-forge documentation
+    url: https://conda-forge.org/docs/
+    about: The complete conda-forge documentation.
+  - name: Conda-forge packages
+    url: https://conda-forge.org/feedstock-outputs/
+    about: For when you have an issue with a specific package.

.github/ISSUE_TEMPLATE/docs_error_template.yml

@@ -0,0 +1,50 @@
+name: Correct existing content
+description: Suggest a correction of the conda-forge docs.
+labels:
+  - Docs
+  - bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for improving the conda-forge docs!
+        
+        Please check to make sure someone hasn't already opened a similar [issue](https://github.com/conda-forge/conda-forge.github.io/issues) and then fill out the form below.
+        
+        If you would like to add something to the docs, please open an issue with a suggestion instead or directly make a PR.
+        _Note:_ As we're all volunteers, we cannot promise to include your change immediately and encourage you therefore to create a [PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) instead. Don't worry about the completeness of it, we are happy to help with any questions you might have!
+
+  - type: input
+    attributes:
+      label: Where should the content be changed?
+      description: Please provide a link to the page where the incorrect content appears.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: What should be changed?
+      description: |
+        Please insert the content to be changed and what should be changed.
+        This can be just a couple of bullet points or the text to be included.
+        
+        _Note:_ If you already have a pretty good idea of what the change should look like, you can also open a [PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) and change the content yourself.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: Add any more info or links that explain what you want to change.
+    validations:
+      required: false
+
+  - type: checkboxes
+    attributes:
+      label: Incorrect or outdated
+      description: Is the content incorrect or outdated?
+      options:
+      - label: Incorrect
+      - label: Outdated
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/docs_suggestion_template.yml

@@ -0,0 +1,41 @@
+name: Improve existing content
+description: Make a suggestion about the conda-forge docs.
+labels:
+  - Docs
+  - enhancement
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for improving the conda-forge docs!
+        
+        Please check to make sure someone hasn't already opened a similar [issue](https://github.com/conda-forge/conda-forge.github.io/issues) and then fill out the form below.
+        
+        If you believe that something is incorrect in the docs, please open an issue with a fix instead or directly make a PR.
+        _Note:_ As we're all volunteers, we cannot promise to include your change immediately and encourage you therefore to create a [PR](https://github.com/conda-forge/conda-forge.github.io/pulls) instead. Don't worry about the completeness of it, we are happy to help with any questions you might have!
+
+  - type: input
+    attributes:
+      label: Where should the content be added?
+      description: In case the content fits onto an already exisiting page, please provide its name or link to it here.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: What should be added?
+      description: |
+        Please insert the content to be added.
+        
+        This can be just a couple of bullet points or the text to be included.
+        
+        _Note:_ If you already have a pretty good idea of what the addtion should look like, you can also open a [PR](https://github.com/conda-forge/conda-forge.github.io/pulls) and add the content yourself.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: Add any more info or links that explain what you want to add.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/error_template.yml

@@ -0,0 +1,47 @@
+name: Report an issue
+description: Report an issue you are experiencing.
+labels: bug
+body:
+    - type: markdown
+      attributes:
+        value: |
+          Thanks for reporting your issue.
+          Please fill out the sections below.
+    - type: checkboxes
+      id: cf-documentation
+      attributes:
+        label: Conda-forge documentation
+        description: Please confirm that you read [the conda-forge documentation](https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge) and could not find a solution for your problem there.
+        options:
+        - label: I could not solve my problem using the conda-forge documentation.
+          required: true
+    - type: textarea
+      id: installed
+      attributes:
+        label: Installed packages
+        description: |
+          Please share your installed packages by running `conda list` and entering the output below:
+          _Note:_ This will be automatically formatted as code.
+        placeholder: "conda list"
+        render: shell
+      validations:
+        required: true
+    - type: textarea
+      id: Info
+      attributes:
+        label: Environment info
+        description: |
+            Please share your environment by running `conda info` and entering the output below:
+            _Note:_ This will be automatically formatted as code.
+        placeholder: "conda info"
+        render: shell
+      validations:
+        required: true
+    - type: textarea
+      id: Issue
+      attributes:
+        label: Issue
+        description: |
+            Please descripe the issue you are experiencing:
+      validations:
+        required: true

.github/ISSUE_TEMPLATE/general_template.yml

@@ -0,0 +1,8 @@
+name: Ask a general question
+description: Ask a general question about conda-forge.
+labels: question
+body:
+  - type: textarea
+    id: comment
+    attributes:
+       label: "Your question:"

.github/workflows/deploy.yml

@@ -3,8 +3,9 @@ name: deploy
 on:
   push:
     branches:
-      - master
+      - main
   pull_request: null
+  workflow_dispatch: null
 
 jobs:
   tests:
@@ -15,33 +16,28 @@ jobs:
 
       - uses: conda-incubator/setup-miniconda@v2
         with:
-          python-version: 3.7
-          channels: conda-forge,defaults
+          python-version: 3.8
+          channels: conda-forge
           channel-priority: strict
           show-channel-urls: true
-
-      - name: configure conda
-        shell: bash -l {0}
-        run: |
-          # configure bot account
-          git config --global user.name "Travis-CI on github.com/conda-forge/conda-forge.github.io"
-          git config --global user.email [email protected]
-
-          # configure conda
-          conda config --set show_channel_urls true
-          conda config --set auto_update_conda false
+          miniforge-version: latest
+          miniforge-variant: Mambaforge
+          activate-environment: conda-forge-docs
+          environment-file: .ci_scripts/environment.yml
 
       - name: build
         shell: bash -l {0}
         run: |
           source ./.ci_scripts/update_docs
+        env:
+          GHREF: ${{ github.ref }}
 
       - name: deploy
-        if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+        if: github.ref == 'refs/heads/main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages
           publish_dir: .
-          user_name: conda-forge-coordinator
-          user_email: conda.forge.coordinator@gmail.com
+          user_name: conda-forge-admin
+          user_email: pelson.pub+conda-[email protected]