Skip to content

Commit

Permalink
Modify the setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
a1eksb committed Jul 12, 2024
1 parent 9a36ac3 commit 3725d5c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
11 changes: 8 additions & 3 deletions docs/docs/docs/setup_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,13 @@ nav:
on:
push:
branches:
- main
paths:
- docs/**/*
pull_request:
branches:
- main
paths:
- docs/**/*
Expand All @@ -65,10 +69,11 @@ nav:
echo "Deploying the docs"
curl --request POST ${{ secrets.ACINT_URL }} -H "Content-Type: application/json" -d "{\"action\": \"${{ secrets.ACINT_ACTION }}\", \"token\": \"${{ secrets.ACINT_TOKEN }}\"}"
```
3. Set the required secrets
3. Copy the `docs` folder at the root of the [docs project](https://github.com/ETH-NEXUS/nexus-docs) into the root of your project.
3. Make sure to modify the branch on which you want this job to be triggered.
4. Set the required secrets
5. Copy the `docs` folder at the root of the [docs project](https://github.com/ETH-NEXUS/nexus-docs) into the root of your project.

4. Expand your `docker-compose.yml` file:
6. Expand your `docker-compose.yml` file:

```yaml title="docker-compose.yml" linenums="1"
services:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/docs/setup_gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ nav:
script:
- echo "Building the docs"
- |
curl --user "$DOCS_USER:$DOCS_PASS" --request POST $ACINT_URL -H "Content-Type: application/json" -d "{\"action\": \"$ACINT_ACTION\", \"token\": \"$ACINT_TOKEN\"}"
curl --request POST $ACINT_URL -H "Content-Type: application/json" -d "{\"action\": \"$ACINT_ACTION\", \"token\": \"$ACINT_TOKEN\"}"
only:
changes:
- "docs/**/*"
Expand Down

0 comments on commit 3725d5c

Please sign in to comment.