Add environment configuration guide #126
Conversation
There was a problem hiding this comment.
Thank you! This documentation will definitely be helpful in the future, I made some suggestion here and there but it seems good for me.
Since we are moving to GitHub Pages for the documentation I think this PR will remain open until that is merged, then we will move this in the docs folder. If you never used GitHub Pages don't worry they fully support .md files so you don't need to make specific changes for it 😁
DEVELOPER_GUIDE.md
Outdated
| and various installation methods can be employed. | ||
| You have the flexibsuility to choose an alternative approach that suits your preferences. | ||
|
|
||
| ## Prerequisites |
There was a problem hiding this comment.
You list IntelliJ and SDKs as prerequisites but then you explain how to install them, maybe we should change the name of this section or just leave the only the OS
DEVELOPER_GUIDE.md
Outdated
| @@ -0,0 +1,305 @@ | |||
| # Dev Environment Configuration | |||
There was a problem hiding this comment.
Since this is specific for Linux I would change the title to "Linux Dev Environment Configuration" and I would do the same thing for the file name
There was a problem hiding this comment.
I would move this in the asset folder
There was a problem hiding this comment.
I appreciate the feedback. I will proceed to make the necessary changes accordingly.
|
Thank you for your feedback! I'm glad to hear that the documentation is useful. Regarding the move to GitHub Pages, I'm completely on board. I haven't used GitHub Pages before, but I'm aware that they fully support .md files, so I intentionally wrote the guide with that in mind. Looking forward to any further guidance during the transition! 😊🚀 |
|
Hi! We enabled the page so now you can go forward with the changes and then we will close and merge this PR. As I told you you'll have to move all the changes that you made to the /docs folder, all the images should go in the /docs/assets folder. You will find more info on how to check the page in your repo and other parts that we want to add in the issue #123 |
|
Hi @gioisco did you have time to look at the changes that I suggested? Let me know if you need anything 😁 |
- Following the reviewer's feedback, I renamed the 'Prerequisites' section. - Additionally, corrected some misspellings and formatted the sections to match the existing setup.md format.
|
I've implemented the requested changes. Additionally, I fixed some misspellings, improved the titles of sections, and moved the files under the 'docs' directory (the screenshot is now in the 'assets' directory). Finally, I included a link to the Linux setup guide in the 'Useful Links' section on the GitHub Page home (the README under the 'docs' directory). |
Summary:
I've created a comprehensive guide with 10 steps to help developers set up their environment for building and running the sossoldi app.
Currently tailored for Linux OS, particularly Pop!_OS, and utilizes the IntelliJ Community Edition as the preferred IDE.
Feel free to enhance the guide with additional configurations to cover diverse environments.
Changes:
Added DEVELOPER_GUIDE.md
Included a screenshot, for better understand how to install
cmdline-tools(Screenshot_Intellij_cmdline-tools.png)You can see the guide here