4.0 KiB
How to contribute to https://github.com/rusefi/rusefi_documentation
Step 0: Edits are possible directly via https://wiki.rusefi.com 'Edit in GitHub' button. A Fork and PR will be created.
Step 1: Alternatively, sign up or sign in to https://github.com
Step 2: Open https://github.com/rusefi/rusefi_documentation and click 'Fork' - this would produce your own fork/copy of rusefi_documentation which you can now edit right in your browser!
Step 3: Edit your code and Commit changes using the button below the editor.
Step 4: Once you are ready to contribute your changes, hit 'New pull request' button on the main page of your fork.
This would produce a Pull request like this in the official rusefi repository and your changes would probably soon become public!
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input
How to contribute to rusEFI TunerStudio project
Same as above, fork https://github.com/rusefi/rusefi and edit your local copy of https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input file
9d9ae5a054 is an example of how more help could be added
right into TunerStudio project file. Lines with green background are the lines being added.
Unfortunately while you would be modifying your mainController.ini file while trying your changes, you need to edit rusefi.input file which is a template from which rusefi.ini is generated programmatically on rusefi side.
Wiki location migration
As of Dec 2022, https://github.com/rusefi/rusefi/wiki called "wiki2-human" is the primary documentation URL. wiki.rusefi.com migration is on-going we are fighting some issues.
Technical implementation details
Github Wiki is weird.
One the one hand, we have https://github.com/rusefi/rusefi_documentation called "wiki2-technical" - that's a git repository with nice pull request process, but less nice web page rendering which start each folder by showing list of files, that's not what end users want to see.
On the other hand, we have https://github.com/rusefi/rusefi/wiki which is displayed much nicer - and that https://github.com/rusefi/rusefi/wiki is actually implemented by ANOTHER git repository https://github.com/rusefi/rusefi.wiki.git behind the scene. That https://github.com/rusefi/rusefi.wiki.git repository does not have a nice Pull Request process :(
Solution? A combination. wiki2-human and wiki2-technical repositories are actually set to mirror each other. This way we have the nice Pull Request process on https://github.com/rusefi/rusefi_documentation and once changes are merged into https://github.com/rusefi/rusefi_documentation, complete https://github.com/rusefi/rusefi_documentation is automatically merged into https://github.com/rusefi/rusefi.wiki.git which makes actual content nicely visible at https://github.com/rusefi/rusefi/wiki Synchronization between wiki2-human and wiki2-technical is automated via Github Action, file content is expected to be the same between these two repositories.
Technical FAQ
Q: Is it ok that https://github.com/rusefi/rusefi.wiki.git cannot be opened from browser?
A: There is no reason to open https://github.com/rusefi/rusefi.wiki.git from browser. Also while you technically CAN "git clone https://github.com/rusefi/rusefi_documentation.wiki.git" and it would work - you should NOT. Anyone looking to make changes should be making changes to non-wiki git via normal fork & pull request process.
Additional automation is in charge of merging from https://github.com/rusefi/rusefi_documentation.git into https://github.com/rusefi/rusefi_documentation.wiki.git