split module installation and rewrite getting started index page #97
Conversation
Summary of ChangesHello @celinenilla, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the OpenSPP documentation by reorganizing how users approach module installation and initial setup. By breaking down complex installation steps into more manageable, product-specific guides and revamping the "Getting Started" page, the changes aim to provide a more intuitive and user-friendly onboarding experience for new OpenSPP implementers. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation by splitting the module installation guide into separate pages for each base module and rewriting the 'Getting Started' index page for better clarity. The changes make the documentation more structured and easier to navigate for new users. I've found a couple of broken links in the new installation pages due to outdated module paths, which should be corrected. I've also suggested removing <br> tags from the index page in favor of standard Markdown for better maintainability.
|
|
||
| 1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) <installation_deb>` | ||
|
|
||
| <br> |
There was a problem hiding this comment.
Using <br> tags for vertical spacing is generally discouraged in Markdown files as it mixes HTML presentation with content. Relying on Markdown's native paragraph spacing (blank lines) is preferred for readability and maintainability.
|
|
||
| 2. **{doc}`Module installation <module_installation>`** | ||
| Choose {doc}`SP-MIS <../overview/products/sp_mis>`, {doc}`Social Registry <../overview/products/social_registry>`, or {doc}`Farmer Registry <../overview/products/farmer_registry>` | ||
| <br> |
There was a problem hiding this comment.
Using <br> tags for vertical spacing is generally discouraged in Markdown files as it mixes HTML presentation with content. Relying on Markdown's native paragraph spacing (blank lines) is preferred for readability and maintainability.
|
|
||
| 1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) <installation_deb>` | ||
|
|
||
| <br> |
There was a problem hiding this comment.
Using <br> tags for vertical spacing is generally discouraged in Markdown files as it mixes HTML presentation with content. Relying on Markdown's native paragraph spacing (blank lines) is preferred for readability and maintainability.
|
|
||
| 2. Choose modules to install. Read more about {doc}`module installation <module_installation>` and {doc}`available modules <../reference/modules/index>` | ||
|
|
||
| <br> |
There was a problem hiding this comment.
Using <br> tags for vertical spacing is generally discouraged in Markdown files as it mixes HTML presentation with content. Relying on Markdown's native paragraph spacing (blank lines) is preferred for readability and maintainability.
|
|
||
| :::{important} | ||
| The **SP-MIS** ({doc}`spp_base </reference/modules/spp_base>`), and **Farmer Registry** ({doc}`spp_farmer_registry_base </reference/modules/spp_farmer_registry_base>`) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error. | ||
| The **SP-MIS** ({doc}`spp_base_spmis </reference/modules/spp_base_spmis>`), **Farmer Registry** ({doc}`spp_base_farmer_registry </reference/modules/spp_base_farmer_registry>`) and **Social Registry** ({doc}`spp_base_social_registry </reference/modules/spp_base_social_registry>`) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error. |
There was a problem hiding this comment.
The link for spp_base_spmis seems to be incorrect in another file. While it is correct here, the corresponding installation file spmis_installation.md points to the old module name spp_base. This is just a note that you've correctly updated it here, but it needs fixing elsewhere.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
No description provided.