add pixi.toml (#2546)

* add pixi.toml

* Update Pixi setup with tasks and platforms

* Use Pixi in CI (GHA and Netlify)

* update environment.yml

* explicit paths for pixi install in netlify

* Update contribution guidelines

* it's build-production

* Re-add install to `pixi run start`

* Update links

* and here

* Fix anchor links

* Check requirements are in sync

* prettier: ignore .ci_scripts/environment.yml

* Tiny details

---------

Co-authored-by: jaimergp <[email protected]>

Author: wolfv

.ci_scripts/environment.yml

@@ -1,9 +1,10 @@
 name: conda-forge-docs
 channels:
-  - conda-forge
+- conda-forge
+- nodefaults
 dependencies:
-  - python=3
-  - requests
-  - pip
-  - nodejs 20.*
-  - pre-commit
+- curl *
+- nodejs 24.*
+- pre-commit *
+- python 3.*
+- requests *

.github/workflows/deploy.yml

@@ -14,20 +14,10 @@ jobs:
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
 
-      - uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f # v3.2.0
-        with:
-          python-version: 3.8
-          channels: conda-forge
-          channel-priority: strict
-          show-channel-urls: true
-          miniforge-version: latest
-          activate-environment: conda-forge-docs
-          environment-file: .ci_scripts/environment.yml
+      - uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7 # v0.9.3
 
       - name: build
-        shell: bash -l {0}
-        run: |
-          source ./.ci_scripts/update_docs
+        run: pixi run build-production
         env:
           GHREF: ${{ github.ref }}
           GHREPO: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
@@ -64,3 +54,12 @@ jobs:
             --remap "https://conda-forge.org/(.*) file://$(pwd)/build/\$1"
             './build/**/*.html'
             '*.md'
+
+      - name: Check Pixi and environment.yml are in sync
+        run: |
+          pixi workspace export conda-environment > .ci_scripts/environment.yml
+          sed -i -e 's/name: default/name: conda-forge-docs/g' -e '/^$/d' .ci_scripts/environment.yml
+          if ! git diff --exit-code .ci_scripts/environment.yml; then
+            echo "error: pixi.toml and environment.yml are out of sync"
+            exit 1
+          fi

.gitignore

@@ -54,6 +54,11 @@ yarn-error.log*
 # pyc files
 *.pyc
 __pycache__/
+*.egg-info
+
+# pixi environments and lockfiles
+.pixi
+pixi.lock
 
 # vscode stuff
 .vscode

.prettierignore

@@ -11,3 +11,5 @@ static/
 .github/
 vote-results/
 misc/
+*.mdx
+.ci_scripts/environment.yml

README.md

@@ -21,12 +21,15 @@ If you have questions or need help, please check out our documentation for a [li
 
 1.  [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [conda-forge.github.io](https://github.com/conda-forge/conda-forge.github.io) repository to your own GitHub user account.
 2.  [Clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this fork onto your computer.
-3.  Go into the main folder.
-    Run the following commands.
-    - `conda env create -f ./.ci_scripts/environment.yml`
-    - `conda activate conda-forge-docs`
-    - For live builds, `npm install && npm run start`
-    - For production builds, run `.ci_scripts/update_docs`
+3.  Go into the cloned folder and:
+    - If you are using `pixi`:
+      - Use `pixi run start` for live builds
+      - Use `pixi run build-production` for production builds
+    - If you are using `conda` or `mamba` (replace command accordingly):
+      - `conda env create -f ./.ci_scripts/environment.yml`
+      - `conda activate conda-forge-docs`
+      - For live builds, `npm install && npm run start`
+      - For production builds, run `.ci_scripts/update_docs`
 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.
 

docs/index.md

@@ -23,8 +23,8 @@ Chances are we have already packaged it for you. You can [search](https://anacon
   - [Contribute new packages](maintainer/adding_pkgs.md)
   - Help update and [maintain packages](maintainer/updating_pkgs.md)
   - Suggest or implement improvements for our [infrastructure](maintainer/infrastructure.md)
-  - Help [improve the documentation](user/contributing.md#improve-docs)
-  - For a detailed overview please refer to [Becoming involved](user/contributing.md)
+  - Help [improve the documentation](/docs/user/contributing/#improve-the-website)
+  - For a detailed overview please refer to [Becoming involved](user/contributing.mdx)
 - To see our governance policies, see [Governance](/community/governance/).
 - If you find bugs, need help, or want to talk to the developers, use our mailing lists or chat rooms:
   - [GitHub issues](https://github.com/conda-forge/conda-forge.github.io/issues)

docs/maintainer/infrastructure.md

@@ -138,7 +138,7 @@ The current [conda-forge.org](https://conda-forge.org) is a statically generated
 
 The documentation is built with Docusaurus and the source files are located in the [`docs/`](https://github.com/conda-forge/conda-forge.github.io/tree/main/docs) directory of the repository.
 
-If you find any typos, errors, unclear explanations, or new topics that can be covered, you can suggest changes to the documentation. For more details, please refer to [Improve the documentation](../user/contributing.md#improve-docs).
+If you find any typos, errors, unclear explanations, or new topics that can be covered, you can suggest changes to the documentation. For more details, please refer to [Improve the documentation](/docs/user/contributing/#improve-the-website).
 
 In addition to the static documentation, the website also offers information on the current status of conda-forge as well as a mapping of packages to feedstocks.
 

docs/user/contributing.md docs/user/contributing.mdxdocs/user/contributing.md renamed to docs/user/contributing.mdx

@@ -2,7 +2,8 @@
 title: 'Becoming involved'
 ---
 
-<a id="becoming-involved"></a>
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 <a id="id1"></a>
 
@@ -81,25 +82,30 @@ If you are new to the conda-forge community, follow the steps below to make your
    ```
    git checkout -b <new-branch-name>
    ```
-4. Run the following commands:
-   ```
-   conda env create -f ./.ci_scripts/environment.yml
-   ```
-   conda activate conda-forge-docs
-5. While writing your new documentation, you can use the live preview mode with:
-   - `npm install` to make sure `node_modules` is up-to-date
-   - `npm run start` to start the live preview. Every time you save a file, the changes will be reflected instantaneously.
-6. Once ready, you can also check how the production build would look like with the commands:
-   ```
-   .ci_scripts/update_docs
-   python -m http.server --directory build/
-   ```
-7. Add and commit your changes:
+4. Depending on your tool of choice, run these commands to obtain a live preview of the changes:
+
+   <Tabs>
+      <TabItem label="conda, mamba" value="conda">
+         ```
+         conda env create -f ./.ci_scripts/environment.yml
+         conda activate conda-forge-docs
+         npm install
+         npm run start
+         ```
+      </TabItem>
+      <TabItem label="pixi" value="pixi" default="True">
+         ```
+         pixi run start
+         ```
+      </TabItem>
+   </Tabs>
+
+5. Once ready, add and commit your changes:
    ```
    git add .
    git commit -m "your commit message"
    ```
-8. Submit a [pull request](https://help.github.com/articles/about-pull-requests/) to the main repository proposing your changes.
+6. Submit a [pull request](https://help.github.com/articles/about-pull-requests/) to the main repository proposing your changes.
    The CI pipelines will include a PR preview on Netlify.
 
 Happy contributing!

docs/user/introduction.md

@@ -16,7 +16,7 @@ conda-forge is a community effort that provides conda packages for a wide range
 
 You can [search](https://anaconda.org/) for packages online. Look out for packages provided by our conda-forge organization.
 
-**Cannot find a package or only outdated versions of a package?** - Everybody is welcome to contribute to our package stack! Please refer to [Becoming involved](contributing.md#becoming-involved), for an overview on how to start contributing.
+**Cannot find a package or only outdated versions of a package?** - Everybody is welcome to contribute to our package stack! Please refer to [Becoming involved](contributing.mdx), for an overview on how to start contributing.
 
 <a id="why-conda-forge"></a>
 

netlify.toml

@@ -5,15 +5,7 @@
   publish = "build"
 
   # Default build command.
-  command = """
-    curl -L -o miniforge.sh https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh &&
-    bash miniforge.sh -bfp ~/miniforge &&
-    rm -rf miniforge.sh &&
-    source ~/miniforge/etc/profile.d/conda.sh &&
-    conda env create -f .ci_scripts/environment.yml &&
-    conda activate conda-forge-docs &&
-    ./.ci_scripts/update_docs
-  """
+  command = 'curl -fsSL https://pixi.sh/install.sh | PIXI_HOME=~/.pixi sh && ~/.pixi/bin/pixi run build-production'
 
   # We only want to build PR previews.
   # Exit code == 0 means that the build is ignored.