rusefi
/
rusefi_documentation
mirror of https://github.com/rusefi/rusefi_documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Testing instructions (#320) 

* add doc

* add spaces for newlines
This commit is contained in:
David Holdeman 2022-12-28 21:51:15 -06:00 committed by GitHub
parent ea0d9d85a8
commit af72ba7e1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
HOWTO-Test-Doc-Changes.md Normal file
View File

@ -0,0 +1,41 @@
# Testing Documentation Changes
## Wiki2
###Setup:
You must have a fork of the main rusefi repo as well as a fork of the rusefi_documentation repo.
Clone your fork of the rusefi_documentation repo:
`git clone git@github.com:<your username>/rusefi_documentation.git`
From your clone, add your wiki as a remote and push to it.
```
git remote add wiki git@github.com:<your username>/rusefi.wiki.git
git fetch wiki
git push wiki
```
This will get your wiki2 up and running. Now you can make changes, and run
```
git commit -am "your commit message"
git push wiki
```
to test them on wiki2.
You might have to use `git push --force wiki`.
Also, note that the changes must be in the master branch of your fork for this to work.
If you want the changes to be synced automatically, you will have to change the usernames in your forks' action files.
Specifically, these action workflows:
[rusefi_documentation/.github/workflows/sync-wiki.yaml](https://github.com/rusefi/rusefi_documentation/blob/master/.github/workflows/sync-wiki.yaml)
[rusefi/.github/workflows/sync-wiki.yaml](https://github.com/rusefi/rusefi/blob/master/.github/workflows/sync-wiki.yaml)
You need to set up an access token in your repository secrets for Actions.
## Wiki3
The easiest way to test Wiki3 is locally. You could also set up a webserver and your repository secrets to let the workflow upload it for you, but here I'll just explain how to test locally.
The full instructions for installing MkDocs can be found [here](https://www.mkdocs.org/user-guide/installation/), but the short version is to run `pip install mkdocs`.
You will also need the EzLinks plugin, which you can install with `pip install mkdocs-ezlinks-plugin`.
Once MkDocs is installed, you can now generate the site.
I do this with a one-liner, run from the root directory of the repo:
`cd mkdocs; rm -r docs site; mkdir docs; cp -r ../!(mkdocs) docs; cp style.css docs; mkdocs build; cd ..`
MkDocs expects the Markdown documentation files to be in a "docs" subdirectory, so we create it and move everything to it, and then we can go ahead and build the site.