habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/scripts: final-ish readme with troubleshooting tips (#10948)

Browse Source 
* added note to readme

* fixed env file

* tweaks

* moved env file

* add more troubleshooting

* ran make website

---------

Co-authored-by: Tana M Berry <tana@goauthentik.com>
This commit is contained in:
Tana M Berry
2024-08-16 10:54:09 -05:00
committed by GitHub
parent d75cdfeaf1
commit 53b89b71e2
3 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
website/docsmg.env Normal file
View File

@ -0,0 +1 @@
MIGRATE_PATH=./docs

19
website/scripts/docsmg/README.md
View File

@ -24,8 +24,15 @@ Use this migration tool to:
1. Navigate to the `authentik/website` dir. 1. Navigate to the `authentik/website` dir.
2. Generate a migratefile with `docsmg generate | sort >> migratefile`. 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. You can also just run `docsmg generate | sort` to see the output in the terminal, before writing it to a file.
:::info The new `migratefile` will be created in the `/website` dir.
:::
3. Edit the `migratefile` to add the target directory paths in the new structure for each entry. 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. For each file listed in `migratefile` insert the path you want to move them to.
EXAMPLE: `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 ### Migrate the docs
@ -35,7 +42,8 @@ Use this migration tool to:
After you have run `migrate`, you cannot run it again or you will get a `panic` error... because the files have already been moved. After you have run `migrate`, you cannot run 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` file in befor running `unmigrate`. 2. To revert the migration, use `docsmg unmigrate`.
Note: DO NOT edit the `migratefile` file in befor running `unmigrate`.
3. Continue modifying the `migratefile` file and then using the `docsmg migrate` command until you are satisfied with the result. 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` ### Update the `sidebar.js file`
@ -45,3 +53,10 @@ Because the structure is completely changed, you will need to modify/reconstruct
## Test the results ## Test the results
To test the internal links, navigate up a level to `authentik` and then run `make website-watch`. To test the internal links, navigate up a level to `authentik` and then run `make website-watch`.
## Toubleshooting
- If the `docsmg generate` command pulls _all_ of the files in the repo (even non-docs files), then check that:
- the `docsmg.env` exists
- that it is in `/website`
- the content is `MIGRATE_PATH=./docs`

1
website/scripts/docsmg/docsmg.env
View File

@ -1 +0,0 @@
MIGRATE_FILE=./docs