import this
6fc4a06b3b
* initialise performance testing pages * draft perfomance testing flow * initialise metric template page * add guides TOC * spell check * edit metrics monitoring page * syntax edit * draft initial prometheus setup flow * add prometheus config * setup prometheus systemd service * add self-hosted-monitor scripts * steps to run explorenym self-hosted monitor * add screenshots and explain steps * changed test page url and syntax edit * add grafana info * finalise explorenym scripts page and initialise docker page * initialise node setup page * clarify remaining todos and sort summary * add initial node setup steps * update node-setup * update docker setup layout * syntax edit * simplify node-setup and add troubleshooting * fix typo * implement feedback * new release version * remove sandbox from nymvpn gui guides * cleaning after FF testing * add blacklist troubleshooting * added run command * address review comments
Documentation
Doc projects
Each directory contains a readme with more information about running and contributing to the projects. Each is built with mdbook - use mdbook serve to build and serve them (defaults to localhost:3000).
docscontains technical documentation hosted at https://nymtech.net/docsdev-portalcontains developer documentation hosted at https://nymtech.net/developersoperatorscontains node setup and maintenance guides hosted at https://nymtech.net/operators
If you are looking for the Typescript SDK documentation located at sdk.nymtech.net this can be found in
../sdk/typescript/docs/
Contribution
- If you wish to add to the documentation please create a PR against this repo.
- If you are adding a plugin dependency make sure to also add that to the list of plugins in
install_mdbook_deps.shline 12.
Scripts
-
bump_versions.shallows you to update theplatform_release_versionandwallet_release_versionvariablesin thebook.tomlof each mdbook project at once. You can also optionally update theminimum_rust_versionas well. Helpful for lazy-updating when cutting a new version of the docs. -
The following scripts are used by the
ci-dev.ymlandcd-dev.ymlscripts (located in../.github/workflows/):build_all_to_dist.shis used for building all mdbook projects and moving the rendered html to../dist/to be rsynced with various servers.install_mdbook_deps.shchecks for an existing install of mdbook (and plugins), uninstalls them, and then installs them on a clean slate. This is to avoid weird dependency clashes if relying on an existing mdbook version.post_process.shis used to post process CSS/image/href links for serving several mdbooks from a subdirectory.removed_existing_config.shis used to check for existing nym client/node config files on the CI/CD server and remove it if it exists. This is to mitigate issues withmdbook-cmdrunwhere e.g. a node is already initialised, and the command fails.
CI/CD
Deployment of the docs is partially automated and partially manual.
ci-docs.ymlwill run on pushes to all branches apart frommastercd-docs.ymlmust be run manually. This pushes to a staging branch which then must be manually promoted to production.
Licensing and copyright information
This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.
As a general approach, licensing is as follows this pattern:
-
Nym Documentation by Nym Technologies is licensed under CC BY-NC-SA 4.0
-
Nym applications and binaries are GPL-3.0-only
-
Used libraries and different components are Apache 2.0 or MIT