feat(doc): fluidattacks#1044 rm configuring-ci-cd

- Move CI/CD examples to usage in container section - Move trusted users config to api/performance - Move api before versioning Signed-off-by: Daniel Salazar <[email protected]>
dsalaza4 · Mar 16, 2023 · 26dfd7a · 26dfd7a
1 parent 6075796
commit 26dfd7a
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 133 deletions.
diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml
@@ -107,8 +107,6 @@ plugins:
 nav:
   - index.md
   - getting-started.md
-  - configuring-ci-cd.md
-  - versioning.md
   - API:
       - builtins:
           - api/builtins/index.md
@@ -138,6 +136,7 @@ nav:
           - api/extensions/patchers.md
           - api/extensions/python.md
           - api/extensions/ruby.md
+  - versioning.md
   - architecture.md
   - contributing.md
   - governance.md

diff --git a/docs/src/api/builtins/performance.md b/docs/src/api/builtins/performance.md
@@ -51,3 +51,17 @@ Example:
       };
     }
     ```
+
+### Configuring trusted-users
+
+If you decided to go
+with a Multi-user installation
+when installing Nix,
+you will have to take additional steps
+in order to make the cache work.
+
+As the Multi-user installation
+does not trust your user by default,
+you will have to add yourself
+to the `trusted-users` in the
+[Nix Configuration File](https://www.mankier.com/5/nix.conf).
diff --git a/docs/src/configuring-ci-cd.md b/docs/src/configuring-ci-cd.md
diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md
@@ -62,6 +62,58 @@ We have **thoroughly** tested it in
 x86_64 hardware architectures
 running Linux and MacOS (darwin) machines.
 
+### Using the container
+
+A Makes container can be found
+in the [container registry](https://github.com/fluidattacks/makes/pkgs/container/makes).
+
+You can use it
+to run Makes on any service
+that supports containers,
+including most CI/CD providers.
+
+Example:
+
+=== "GitHub Actions"
+
+    ```yaml
+    # .github/workflows/dev.yml
+    name: Makes CI
+    on: [push, pull_request]
+    jobs:
+      helloWorld:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
+          - uses: docker://ghcr.io/fluidattacks/makes:23.04
+            name: helloWorld
+            with:
+              args: m . /helloWorld 1 2 3
+    ```
+
+=== "GitLab CI"
+
+    ```yaml
+    # .gitlab-ci.yml
+    /helloWorld:
+      image: ghcr.io/fluidattacks/makes:23.04
+      script:
+        - m . /helloWorld 1 2 3
+    ```
+
+=== "Travis CI"
+
+    ```yaml
+    # .travis.yml
+    os: linux
+    language: nix
+    nix: 2.3.12
+    install: nix-env -if https://github.com/fluidattacks/makes/archive/23.04.tar.gz
+    jobs:
+      include:
+        - script: m . /helloWorld 1 2 3
+    ```
+
 ### Importing via Nix
 
 You can also import Makes from Nix: