From 2381e52d3b5c09405d52d97da4d2f1a18435c650 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Mon, 4 Sep 2023 13:28:19 +0200 Subject: [PATCH] removed all instances of platform_release_version var --- documentation/README.md | 4 ++-- documentation/dev-portal/README.md | 2 +- documentation/dev-portal/book.toml | 1 - documentation/dev-portal/src/quickstart/nymconnect-gui.md | 2 +- documentation/docs/README.md | 8 +------- documentation/docs/book.toml | 1 - documentation/docs/src/clients/socks5-client.md | 2 +- documentation/docs/src/sdk/typescript.md | 4 ++-- 8 files changed, 8 insertions(+), 16 deletions(-) diff --git a/documentation/README.md b/documentation/README.md index 9e490e4d57..59c5e32133 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -7,7 +7,7 @@ Each directory contains a readme with more information about running and contrib * `operators` contains node setup and maintenance guides hosted at [https://nymtech.net/operators](https://nymtech.net/operators) ## Scripts -* `bump_versions.sh` allows you to update the `platform_release_version` and `wallet_release_version` variables in the `book.toml` of each mdbook project at once. You can also optionally update the `minimum_rust_version` as well. Helpful for lazy-updating when cutting a new version of the docs. - * `build_all_to_dist.sh` is used by the `ci-dev.yml` and `cd-dev.yml` scripts for building all mdbook projects and moving the rendered html to `../dist/` to be rsynced with various servers. +* `bump_versions.sh` allows you to update the ~~`platform_release_version` and~~ `wallet_release_version` variable~~s~~ in the `book.toml` of each mdbook project at once. You can also optionally update the `minimum_rust_version` as well. Helpful for lazy-updating when cutting a new version of the docs. +* `build_all_to_dist.sh` is used by the `ci-dev.yml` and `cd-dev.yml` scripts for building all mdbook projects and moving the rendered html to `../dist/` to be rsynced with various servers. diff --git a/documentation/dev-portal/README.md b/documentation/dev-portal/README.md index b43fbc7d2c..0b53b8e984 100644 --- a/documentation/dev-portal/README.md +++ b/documentation/dev-portal/README.md @@ -12,7 +12,7 @@ If you have built a project with Nym or are compiling and writing resources abou ## Variables There are some variables that are shared across this book, such as the current latest software version. -Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{platform_release_version}}` is the most recent release), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!** +Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{wallet_release_version}}`), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!** ## Building When working locally, it is recommended that you use `mdbook serve` to have a local version of the docs served on `localhost:3000`, with hot reloading on any changes made to files in the `src/` directory. diff --git a/documentation/dev-portal/book.toml b/documentation/dev-portal/book.toml index 1026b8e77b..88195e1622 100644 --- a/documentation/dev-portal/book.toml +++ b/documentation/dev-portal/book.toml @@ -48,7 +48,6 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install` # https://gitlab.com/tglman/mdbook-variables/ [preprocessor.variables.variables] minimum_rust_version = "1.66" -platform_release_version = "1.1.29" wallet_release_version = "1.2.8" [preprocessor.last-changed] diff --git a/documentation/dev-portal/src/quickstart/nymconnect-gui.md b/documentation/dev-portal/src/quickstart/nymconnect-gui.md index 8783d1b9f5..cf7644b616 100644 --- a/documentation/dev-portal/src/quickstart/nymconnect-gui.md +++ b/documentation/dev-portal/src/quickstart/nymconnect-gui.md @@ -11,7 +11,7 @@ Install NymConnect and select an application that you want to privacy-enhance fr **Please note that NymConnect is currently released in beta. Please report bugs via Github**. ## Usage instuctions -* [Download](https://github.com/nymtech/nym/releases/tag/nym-connect-{{platform_release_version}}) and install NymConnect. +* [Download](https://github.com/nymtech/nym/releases/) and install NymConnect. * Select your service provider from the dropdown menu. * Click `connect` - NymConnect will connect to a service provider and its SOCKS Proxy (IP) and Port will be displayed. * Click on IP or Port to copy their values to the clipboard. diff --git a/documentation/docs/README.md b/documentation/docs/README.md index 8cc1041c73..9a5eab0773 100644 --- a/documentation/docs/README.md +++ b/documentation/docs/README.md @@ -16,7 +16,7 @@ To contribute tranlsations in a new language, please get in touch via [Matrix](h ### Variables There are some variables that are shared across the entire docs site, such as the current latest software version. -Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{platform_release_version}}` is the most recent release), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!** +Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{wallet_release_version}}`), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!** ### Diagrams Most diagrams are simply ascii. Copies are kept in `/diagrams/` for ease of reproducability. Created using [textik](https://textik.com/#). @@ -27,12 +27,6 @@ Example files are inserted as per normal with mdbook. Some binary command outputs are generated using the [`cmdrun`](https://docs.rs/mdbook-cmdrun/latest/mdbook_cmdrun/) mdbook plugin. -### Updating platform version - -When updating the version, make sure to change **both** the version in the `title` on line 2 of `book.toml`, as well as the `platform_release_version` variable in the same file. - -> In the future this will be dealt with something like a preprocessor widget (todo). - ## Building When working locally, it is recommended that you use `mdbook serve` to have a local version of the docs served on `localhost:3000`, with hot reloading on any changes made to files in the `src/` directory. diff --git a/documentation/docs/book.toml b/documentation/docs/book.toml index 846bf5ee2a..b8b6636656 100644 --- a/documentation/docs/book.toml +++ b/documentation/docs/book.toml @@ -48,7 +48,6 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install` # https://gitlab.com/tglman/mdbook-variables/ [preprocessor.variables.variables] minimum_rust_version = "1.66" -platform_release_version = "1.1.29" wallet_release_version = "1.2.8" [preprocessor.last-changed] diff --git a/documentation/docs/src/clients/socks5-client.md b/documentation/docs/src/clients/socks5-client.md index 052a52f027..292848ff8a 100644 --- a/documentation/docs/src/clients/socks5-client.md +++ b/documentation/docs/src/clients/socks5-client.md @@ -160,7 +160,7 @@ Create a service file for the socks5 client at `/etc/systemd/system/nym-socks5-c ```ini [Unit] -Description=Nym Socks5 Client ({{platform_release_version}}) +Description=Nym Socks5 Client StartLimitInterval=350 StartLimitBurst=10 diff --git a/documentation/docs/src/sdk/typescript.md b/documentation/docs/src/sdk/typescript.md index 0691f02f26..49bc816738 100644 --- a/documentation/docs/src/sdk/typescript.md +++ b/documentation/docs/src/sdk/typescript.md @@ -53,10 +53,10 @@ The best place to start if you just want to quickly get a basic frontend up and As you can see, all that is required to create an ephemeral keypair and connect to the mixnet is creating a client and then subscribing to the mixnet events coming down the websocket, and adding logic to deal with them. #### Parcel -If you don't want to use `Webpack` as your app bundler, we have an example with `Parcel` located at [`examples/parcel/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/parcel/). +If you don't want to use `Webpack` as your app bundler, we have an example with `Parcel` located at [`examples/parcel/`](https://github.com/nymtech/nym/tree/master/sdk/typescript/examples/chat-app/parcel). #### Create React App -For React developers we have an example which is a basic React app scaffold with the additional logic for creating a client and subscribing to mixnet events in [`examples/react-webpack-with-theme-example/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/). +For React developers we have an example which is a basic React app scaffold with the additional logic for creating a client and subscribing to mixnet events in [`examples/react-webpack-with-theme-example/`](https://github.com/nymtech/nym/tree/master/sdk/typescript/examples/chat-app/react-webpack-with-theme-example). ### Developers: think about what you're sending (and importing)! Think about what information your app sends. That goes for whatever you put into your Sphinx packet messages as well as what your app's environment may leak.