Skip to content

fix(docs): make MkDocs strict build use docs dir #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carloshvp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): make MkDocs strict build use docs dir #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 1 addition & 18 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,5 @@ jobs:
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

- name: Assemble docs build directory
run: |
BUILD=.docs_build
mkdir -p $BUILD

if [ -d docs ]; then cp -r docs $BUILD/docs; fi

for fname in README.md CHANGELOG.md CONTRIBUTING.md GOVERNANCE.md ROADMAP.md LIMITATIONS.md CNAME robots.txt; do
if [ -f "$fname" ]; then cp "$fname" "$BUILD/$fname"; fi
done

echo "Build dir contains $(find $BUILD -type f | wc -l) files"

- name: Generate build config
run: |
sed 's|^docs_dir: \.$|docs_dir: .docs_build|' mkdocs.yml > .mkdocs_build.yml

- name: Build and deploy to GitHub Pages
run: mkdocs gh-deploy --force --clean --config-file .mkdocs_build.yml
run: mkdocs gh-deploy --force --clean
2 changes: 1 addition & 1 deletion docs/tutorials/kill-switch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Automatically block a rogue agent identity when its deny rate exceeds a threshol
pip install cmcp-runtime
```

An [Agent Manifest](../../docs/spec/component-model.md) must be bound to the gateway so the runtime has a per-agent SPIFFE URI to track. Anonymous sessions (no manifest) are never blocked.
An [Agent Manifest](../spec/component-model.md) must be bound to the gateway so the runtime has a per-agent SPIFFE URI to track. Anonymous sessions (no manifest) are never blocked.

---

Expand Down
Loading
Loading