From 3c1a81dc3cabda9aace27837615a4448135b47ea Mon Sep 17 00:00:00 2001 From: rusefi Date: Mon, 30 Dec 2019 12:08:58 -0500 Subject: [PATCH 1/3] wiki unification --- FAQ/HOWTO_help_rusEfi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/FAQ/HOWTO_help_rusEfi.md b/FAQ/HOWTO_help_rusEfi.md index 34d38de..8ea91fb 100644 --- a/FAQ/HOWTO_help_rusEfi.md +++ b/FAQ/HOWTO_help_rusEfi.md @@ -3,7 +3,7 @@ The weakest point of rusEfi is documentation. If you've played with rusEfi for any time chances are you have help improve the documentation. -[Click here for more details](HOWTO_contribute_to_documentation.md) +[Click here for more details](HOWTO_contribute_to_documentation) #### How to contribute to https://github.com/rusefi/rusefi_documentation From 24b82f9a8b714302ed4b7e4bb181bdc2fe5bf857 Mon Sep 17 00:00:00 2001 From: rusefi Date: Mon, 30 Dec 2019 12:09:58 -0500 Subject: [PATCH 2/3] wiki unification --- FAQ/HOWTO_contribute_to_documentation.md | 27 ++++++++++++++++++++++++ FAQ/HOWTO_help_rusEfi.md | 27 ------------------------ 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/FAQ/HOWTO_contribute_to_documentation.md b/FAQ/HOWTO_contribute_to_documentation.md index 00ef8cd..dbf798b 100644 --- a/FAQ/HOWTO_contribute_to_documentation.md +++ b/FAQ/HOWTO_contribute_to_documentation.md @@ -1,4 +1,31 @@ +#### How to contribute to https://github.com/rusefi/rusefi_documentation + +Step 1: 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! +![editor](github_online_editor.png) + +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](https://github.com/rusefi/rusefi_documentation/pull/3) 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 + +https://github.com/rusefi/rusefi/commit/9d9ae5a05499027b32ed76df3e7ee2e2e8240c31 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. + # Technical implementation details diff --git a/FAQ/HOWTO_help_rusEfi.md b/FAQ/HOWTO_help_rusEfi.md index 8ea91fb..b1f3d35 100644 --- a/FAQ/HOWTO_help_rusEfi.md +++ b/FAQ/HOWTO_help_rusEfi.md @@ -5,33 +5,6 @@ The weakest point of rusEfi is documentation. If you've played with rusEfi for a [Click here for more details](HOWTO_contribute_to_documentation) -#### How to contribute to https://github.com/rusefi/rusefi_documentation - -Step 1: 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! -![editor](github_online_editor.png) - -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](https://github.com/rusefi/rusefi_documentation/pull/3) 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 - -https://github.com/rusefi/rusefi/commit/9d9ae5a05499027b32ed76df3e7ee2e2e8240c31 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. - #### Last but not least From e2fe0afbdec130fa40cc237c0f335f3c82b70926 Mon Sep 17 00:00:00 2001 From: rusefi Date: Mon, 30 Dec 2019 12:30:32 -0500 Subject: [PATCH 3/3] FAQ added --- FAQ/HOWTO_contribute_to_documentation.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/FAQ/HOWTO_contribute_to_documentation.md b/FAQ/HOWTO_contribute_to_documentation.md index dbf798b..d36d7e0 100644 --- a/FAQ/HOWTO_contribute_to_documentation.md +++ b/FAQ/HOWTO_contribute_to_documentation.md @@ -46,3 +46,12 @@ merged into https://github.com/rusefi/rusefi_documentation, complete https://git into https://github.com/rusefi/rusefi_documentation.wiki.git which makes actual content nicely visible at https://github.com/rusefi/rusefi_documentation/wiki +# Technical FAQ + +Q: Is it ok that https://github.com/rusefi/rusefi_documentation.wiki.git cannot be opened from browser? + +A: There is no reason to open https://github.com/rusefi/rusefi_documentation.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