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

Updated Draft of new Documentation Workflow (markdown)

This commit is contained in:
David Holdeman 2021-06-01 16:32:41 -05:00
parent b03fd49c81
commit 5aa56ae05a
1 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Draft-of-new-Documentation-Workflow.md
View File

@ -1 +1,38 @@
let's https://github.com/rusefi/rusefi_documentation/issues/149 here
In order to leverage the github pull request process for access control to the wiki, it is stored in a github repo:
https://github.com/rusefi/rusefi_documentation
When a change is made to the repo, a Github Action automatically builds the wiki and uploads it.
For example, in order for user abelom to edit this page:
1) abelom would start editing at https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md which would automatically create a branch in https://github.com/abelom/rusefi_documentation fork
2) Once changed are made, abelom would create a Pull Request
3) Once that PR is merged into primary rusEFI modified content would appear as https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md
4) Within the next 5 minutes automation would build this page and upload it, and it would be available with nicer layout as https://wiki.rusefi.com/Documentation_Workflow
Same but in different terms:
1) Fork https://github.com/rusefi/rusefi_documentation
2) Make your changes
3) PR your changes
4) Once PR is merged by one of moderators, your changes will appear at https://github.com/rusefi/rusefi_documentation instantaneously
5) Within the next 5 minutes magic happens and the changes appear at https://wiki.rusefi.com
**Q:** Is there a place where we are holding all images for these documents?
**A:** We have images in the same repository! Just add your images while editing pages. Please consider using some (any really) folder structure.
For example https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png is visible on wiki.rusefi.com as https://wiki.rusefi.com/FAQ/images/TunerStudio_new_project.png
### How URLs work
Links to page names use only the name of the page; relative path does not matter.
Example:
`[The Documentation Workflow](Documentation-Workflow)`
Links to images are relative to the .md file they are in.
Example:
`![TunerStudio New Project View](images/TunerStudio_new_project.png)`
**Q:** What sort of fancy options do we have?
**A:** We can do collapsible sections & hints sections! See [cranking](Cranking) for an example.