Resolve "Documentation on how to run the code is hard to read and outdated"
Closes #1186 (closed)
What does this MR do?
Updates developer documentation regarding
How confident are you it won't break things if deployed?
Won't break anything, as it is just a documentation update.
How to test
- Checkout branch locally
- Check the developer documentation on http://localhost:3000
- Especially the pages "Tool installation", "Installation der nötigen Software" und "Getting & running the code"
Checklist
-
added a test, or explain why one is not needed/possible... -> no test, because only documentation change -
no unrelated changes -
asked someone for a code review -
set a "for:" label to indicate who will be affected by this change -
used "state:" labels to track this MR's state until it was beta tested -
added to the next milestone (see https://gitlab.com/foodsharing-dev/foodsharing/-/milestones, unless it has a "for:Dev" label) -
added an entry to CHANGELOG.md -
added a short text that can be used in the release notes -
Once your MR has been merged, you are responsible to create a testing issue in the Beta Testing forum: https://foodsharing.de/?page=bezirk&bid=734&sub=forum. Please change the MRs label to "state:Beta testing". - Consider writing a detailed description in German.
- Describe in a few sentences, what should be tested from a user perspective.
- Also mention different settings (e.g. different browsers, roles, ...) how this change can be tested.
- Be aware, that also non technical people should understand.