From 4925af012d2049edad58f632cbe9cbe8c3bdf8bf Mon Sep 17 00:00:00 2001 From: rusefi Date: Mon, 30 Dec 2019 10:53:14 -0500 Subject: [PATCH] game plan --- FAQ/HOWTO_contribute_to_documentation.md | 21 +++++++++++++++++++++ FAQ/HOWTO_help_rusEfi.md | 2 ++ 2 files changed, 23 insertions(+) create mode 100644 FAQ/HOWTO_contribute_to_documentation.md diff --git a/FAQ/HOWTO_contribute_to_documentation.md b/FAQ/HOWTO_contribute_to_documentation.md new file mode 100644 index 00000000..00ef8cde --- /dev/null +++ b/FAQ/HOWTO_contribute_to_documentation.md @@ -0,0 +1,21 @@ + + + +# Technical implementation details + +Github Wiki is weird. + +One the one hand, we have https://github.com/rusefi/rusefi_documentation - 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_documentation/wiki which is displayed much nicer - and +that https://github.com/rusefi/rusefi_documentation/wiki is actually implemented by ANOTHER git repository +https://github.com/rusefi/rusefi_documentation.wiki.git behind the scene. That https://github.com/rusefi/rusefi_documentation.wiki.git repository does not have a nice Pull Request process :( + +Solution? A combination. Here at rusefi_documentation both 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 merged +into https://github.com/rusefi/rusefi_documentation.wiki.git which makes actual content nicely visible at https://github.com/rusefi/rusefi_documentation/wiki + + diff --git a/FAQ/HOWTO_help_rusEfi.md b/FAQ/HOWTO_help_rusEfi.md index 81e3a084..34d38dea 100644 --- a/FAQ/HOWTO_help_rusEfi.md +++ b/FAQ/HOWTO_help_rusEfi.md @@ -3,6 +3,8 @@ 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) + #### How to contribute to https://github.com/rusefi/rusefi_documentation Step 1: Sign up or sign in to https://github.com