[TASK] Add a "Quick start" tutorial for contributors (DevDays) #345
Conversation
|
Note: I couldn't get the "EXT:styleguide" Frontend Pagetree to work with this DDEV setup. Don't know if it's a bug in the styleguide setup, or a problem with ddev. |
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
Co-authored-by: Stefan Frömken <[email protected]>
This change removes a copy&paste left over from the `Quickstart/Index.rst`.
This change modifies the `Quickstart/1-Prerequisites.rst` to add minor additional information to some points.
This change modifes the `Quickguide/3-Git.rst` file to enhance the experience by ... * ensuring single commands per code block to allow block copy and pasting by using the block copy icon. * using more cross operating-system compatible commands. * note when in a command replacements are needed * add a general tip to copy commands to a text file or editor to do the replacement before pasting it into a terminal * add a additional verification step at the end.
This change modifies `Quickstart/4-DDEV.rst` to enhance the guide slightly.
This change modifies the `Quickstart/5-TYPO3.rst` file to enhance the experience for the user proceeding this chapter by * ensuring to have single command or command chain to simply use the copy icon and have no issues pasting them into the terminal. * adding generic project folder switch as note at the top. * providing `EXT:styleguide` create commands creating the frontend based on `TypoScript records` instead of the Site Sets feature, which seems to be broken for now with ddev. * Reworded the attention block to state the reason instead of leaving a to do - which looks kind of weired for readers.
This change modifies the `Create a patch` chapter slightly to make it more easier for contributors to create their first patch by * ensuring single commands or proper command chains which can be properly copied using the copy icon and pasted into a terminal. * using `:caption:` tags for `code blocks` to explain each command copy block itself. * adding general remember on top to be in the right folder. * adding a additional `cleanup` point at the end providing suitable commands and small explanation.
This change adds a general hint to the `Quick Start: Create a patch - Intention` chapter raising awareness for a clean repository state and how to deal with it if not.
…aces This change streamlines the `reset and cleanup` steps and information throughout multiple places to contain as much information as possible while still beeing able to copy single command and chains for easy copy&paste experiance.
I changed the todo in the PR and the command to generate the |
|
Really great work @garvinhicking and thank you for jumping in after a short pitch for that. That helps us a lot, I'd say. However, pushed some minior things to slightly improve it - at least in my eyes. Hope that is fine for you ! |
This addresses: * Rename "15 minutes" to "under 30 minutes" * Streamline $HOME dir usage * Remove some explanations that enlarge the text too much * Remove some of the prerequisites that are needed, and would otherwise take up too much text. The long version is still part of this guide, it fits there better. * streamline ddev config for rename * fix minor typos
Thank you! I think there are very many improvements to this. I did try to rework it slightly with some follow-up commits. Let's have a chat to finalize it. Working on it together is always a win in my book, even if there are differences in the details, we can work that out :-) |
|
Wow, this was a good piece of work, thanks a lot for taking care of it! |
|
Benni does not have time for it right now (we are all quite busy), but we have the approval to go on and merge it for now if we are confident. He will have a look at a later time. So I'm goint to merge it now as a really good first improvement, and a really big thanks to garvin for the time putted into this improvement ❤️ ! |
No description provided.