Skip to content
netfyrPublic

About

netfyr user documentation

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

netfyr documentation

User documentation for netfyr, built with Material for MkDocs.

Preview

Use Python 3.13:

python3.13 -m venv .venv
.venv/bin/python -m pip install --require-hashes -r requirements.txt
.venv/bin/mkdocs serve

Check

core-ref.json pins the core commit for the guides, reference, and YAML examples. Clone core once to check the generated files against that commit:

git clone https://github.com/netfyr/netfyr .cache/core
.venv/bin/python -m unittest discover -s tests -v
.venv/bin/python scripts/sync_core.py --check
cargo test --locked --manifest-path checks/examples/Cargo.toml
.venv/bin/mkdocs build --strict

The guides include the files in examples/. Rust tests load each file through core's policy parser and call produce() without changing the network.

Updates from core

The Update from core workflow runs daily or on demand. It imports core's state schemas, regenerates the field reference and updates the example checker. It opens a PR after validation passes. Review the linked core changes and update affected guides before merging.

Policy loading, reconciliation, backend operations, and provider support can change without changes to the schemas. Review these when updating core, and update the current support page and configuration guides to match the proposed revision.

The workflow waits while an update PR is open. It skips previously proposed core commits, including closed PRs; reopen the PR to reconsider one.

Update branches include both the core revision and the docs base commit. If PR creation fails and docs main advances, the next run uses a new branch. It leaves the old branch intact and still recognizes PRs for that core revision under either branch name. A retry on the same base reuses the branch only if its files match the generated update.

Validation uses read-only access. A separate job publishes the reference and example dependency pins. Enable the repository's Allow GitHub Actions to create and approve pull requests setting. GitHub may require a maintainer to approve workflows on a bot-created PR. Merge reviewed updates manually so the merge triggers the normal Pages build.

For a local update, fetch core, choose a full commit SHA, then run:

git -C .cache/core fetch origin main
.venv/bin/python scripts/sync_core.py --revision FULL_CORE_COMMIT_SHA
cargo update --manifest-path checks/examples/Cargo.toml -p netfyr-policy -p netfyr-state

Run the checks before committing. Syncing fails on unsupported schema constraints.

License

Documentation and site code: MIT. Fonts: SIL OFL 1.1. Logo artwork: all rights reserved. See NOTICE.

About

netfyr user documentation

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages