Skip to content

Commit

Permalink
tweak readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tana M Berry committed Aug 5, 2024
1 parent a910b72 commit b125bb0
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions website/scripts/docsmg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,36 @@ Use this migration tool to:
- Install [rust](rustup.rs) or update rust to the latest version with `rustup update`
- If installing rust from scratch, you may need to run `. $HOME/.cargo/env`
2. Install the cli tool with `cargo install --git https://github.com/goauthentik/authentik --bin docsmg`
3. In the `/website` directory, create a file named `docsmg.env` with the entry of `MIGRATE_PATH=./docs`.

## 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
### Create the mapping file (`migratefile`)

1. Navigate to the `authentik/website` dir.
2. Generate a migratefile with `docsmg generate | sort >> migratefile`.
You can also just run `docsmg generate | sort` to see the output in the terminal, before writing it to a file.
3. Edit the `migratefile` to add the target directory paths in the new structure for each entry.
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.

### Migrate the docs

1. After you have entered all the paths you want to move, migrate the files with `docsmg migrate`.

:::info
After you have run migate, you cannot rin it again or you will get a `panic` error... because the files have already been moved.
:::

2. To revert the migration, use `docsmg unmigrate`; Note: DO NOT edit the migratefile in between steps 3 and 4.
3. Continue modifying the `migratefile` file and then using the `docsmg migrate` command until you are satisfied with the result.

### Update the `sidebar.js file`

Because the structure is completely changed, you will need to modify/reconstruct the navigation bar.

1.

## Test the results

To test the internal links, navigate up a level to `authentik` and then run `make website-watch`.

0 comments on commit b125bb0

Please sign in to comment.