Remove the FAQ and redirect to ecosystem-wide FAQ (#1934)

* Remove the FAQ and redirect to ecosystem-wide FAQ * Update changelog * Fix link to stereochem FAQ entry * Pin micromamba 1.5.10-0
openforcefield · Oct 2, 2024 · 58b0688 · 58b0688
1 parent fd7b8b0
commit 58b0688
Show file tree

Hide file tree

Showing 10 changed files with 106 additions and 279 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -80,6 +80,10 @@ jobs:
           environment-file: devtools/conda-envs/${{ env.ENVFILE }}.yaml
           create-args: >-
             python=${{ matrix.python-version }}
+          # default - will pull down 2.0 which we don't want!
+          # micromamba-version: latest
+          # pin to latest 1.x release
+          micromamba-version: "1.5.10-0"
 
       - name: Make oe_license.txt file from GH org secret "OE_LICENSE"
         env:

diff --git a/.github/workflows/beta_rc.yaml b/.github/workflows/beta_rc.yaml
@@ -47,6 +47,10 @@ jobs:
               - conda-forge
           create-args: >-
             python=${{ matrix.python-version }}
+          # default - will pull down 2.0 which we don't want!
+          # micromamba-version: latest
+          # pin to latest 1.x release
+          micromamba-version: "1.5.10-0"
 
       - name: Make oe_license.txt file from GH org secret "OE_LICENSE"
         env:

diff --git a/.github/workflows/conda.yml b/.github/workflows/conda.yml
@@ -50,6 +50,10 @@ jobs:
           environment-file: devtools/conda-envs/conda_oe.yaml
           create-args: >-
             python=${{ matrix.python-version }}
+          # default - will pull down 2.0 which we don't want!
+          # micromamba-version: latest
+          # pin to latest 1.x release
+          micromamba-version: "1.5.10-0"
 
       - name: Additional info about the build
         run: |
@@ -128,4 +132,4 @@ jobs:
 
       - name: Run example notebooks
         run: |
-          python -m pytest -r fE -v -x --tb=short --nbval-lax --ignore=examples/deprecated examples
+          python -m pytest -r fE -v -x --tb=short --nbval-lax --ignore=examples/deprecated examples
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -66,6 +66,10 @@ jobs:
           environment-file: devtools/conda-envs/${{env.ENVFILE}}-examples.yaml
           create-args: >-
             python=${{ matrix.python-version }}
+          # default - will pull down 2.0 which we don't want!
+          # micromamba-version: latest
+          # pin to latest 1.x release
+          micromamba-version: "1.5.10-0"
 
       - name: Additional info about the build
         run: |

diff --git a/.github/workflows/installer.yml b/.github/workflows/installer.yml
@@ -109,4 +109,3 @@ jobs:
         # This should work if run directly at release time, but a safer approach would be
         # to `git checkout` the corresponding tag of the release, see PR #577
         pytest $PYTEST_ARGS ../
-
diff --git a/FAQ.md b/FAQ.md
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/index.md b/docs/index.md
@@ -12,7 +12,7 @@ maxdepth: 1
 installation
 examples
 releasehistory
-faq
+Frequently Asked Questions (FAQ) <https://docs.openforcefield.org/faq>
 :::
 
 :::{toctree}

diff --git a/docs/releasehistory.md b/docs/releasehistory.md
diff --git a/docs/users/molecule_cookbook.ipynb b/docs/users/molecule_cookbook.ipynb
@@ -391,7 +391,7 @@
    "id": "821c4687",
    "metadata": {},
    "source": [
-    "We can downgrade this error to a warning with the `allow_undefined_stereo` argument. This will create a molecule with undefined stereochemistry, which might lead to incorrect parametrization or surprising conformer generation. See the [FAQ](../faq.md#im-getting-stereochemistry-errors-when-loading-a-molecule-from-a-smiles-string) for more details."
+    "We can downgrade this error to a warning with the `allow_undefined_stereo` argument. This will create a molecule with undefined stereochemistry, which might lead to incorrect parametrization or surprising conformer generation. See the [FAQ](inv:openff.docs#faq-stereochemistry-errors-from-smiles) for more details."
    ]
   },
   {