website/scripts/docsmg: Bug fixes (#10668)

* add docsmg tool

* moved to the correct scripts directory

* removed test files

* added install script and readme draft to docsmg

* fix install script

* fixed issues

* Revert "fixed issues"

This reverts commit a51192025f.

* Revert "Revert "fixed issues""

This reverts commit ab68918fea.

* added dotenv and updated readme

* fixed install script
This commit is contained in:
Bama
2024-07-28 21:32:29 -05:00
committed by GitHub
parent 270c9661a1
commit ca7705689d
8 changed files with 71 additions and 77 deletions

View File

@ -2,6 +2,14 @@
## Steps to install
1. Install [rustup](https://rustup.rs/) if its not already installed
2. Update to the latest version of rust if you dont already have it with `rustup update`
3. Install the cli tool with `curl https://raw.githubusercontent.com/goauthentik/authentik/main/website/scripts/docsmg/install.sh | sh`
1. Verify that you have the latest version of rust installed
- Install [rust](rustup.rs) or update rust to the latest version with `rustup update`
2. Install the cli tool with `cargo install --git https://github.com/goauthentik/authentik --bin docsmg`
## Steps to use
1. Generate a migratefile with `docsmg generate >> migratefile`
2. Find the files you want to move in `migratefile` and insert the path you want to move them to after the arrow; ex `path/to/move/from/file.md -> path/to/move/to/file.md` Note: make sure to put spaces on either side of the arrow or that line won't be recognized
3. Once you have entered all the paths you want to move, migrate the files with `docsmg migrate`
4. To revert the migration, use `docsmg unmigrate`; Note: DO NOT edit the migrate file inbetween steps 3 and 4
5. Repeat steps 2-4 until you are satified with the result