import this
937be101d2
* initialise operators guides v2 * new introduction page * add variables csv and page * add baseurl to allow short path * add sandbox page * added building from source page * add binary pages * add preliminary steps * clean preliminary steps dir * syntax edit * syntax edit * add configuration page * create new proxy configuration page * create new proxy configuration page * create bonding.mdx page * correct images path * syntax edit * add new validator setup page * add api setup page * add nyx configuration page * add nym node and maintenance pages * finish maintenance and add nymvisor conf page * add manual upgrade page * add nymvisor upgrade page * add performance testing page and dir * add node api check page * add explore nym scripts page * add testing pages * fix menu issue by moving snippets to coomponents * add all troubleshooting pages * add general faq page * add nym node faq page * add nyx faq page * revamp legal forum to community counsel and add all pages * rewire relative paths to new structure * simplify setup and remove lock file * syntax fix * rm package.json * re add package.json, rm package-lock.json * removed old books from commit * address review comments --------- Co-authored-by: mfahampshire <maxhampshire@pm.me> Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>
20 lines
1.0 KiB
Plaintext
20 lines
1.0 KiB
Plaintext
{/*
|
|
TODO - MAKE PLUGIN WHICH CAN RUN PYTHON SCRIPT TO PRINT CSV LOCATED IN ../../data/csv/variables.csv
|
|
*/}
|
|
import { Callout } from 'nextra/components'
|
|
|
|
# Essential Parameters & Variables
|
|
|
|
Our documentation often refer to syntax annotated in `<>` brackets. We use this expression for variables that are unique to each user (like path, local moniker, versions etcetra). Any syntax in `<>` brackets needs to be substituted with your correct name or version, without the `<>` brackets.
|
|
|
|
Below is a table listing the most essential variables and parameters which they may come along with, together with description and syntax example. It should help operators and developers to familiarise themselves with the convention of parameters and variables we use across the documentation.
|
|
|
|
|
|
<Callout>
|
|
To prevent over-flooding of our documentation we cannot provide with every single command syntax as there is a large combination of possibilities. Remember that you can always print the options using a `--help` flag together with any binary command.
|
|
</Callout>
|
|
|
|
|
|
|
|
|