Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for sensitivity module (refs #3876) #3877

Merged
merged 38 commits into from
Aug 26, 2024

Conversation

lpofredc
Copy link
Contributor

@lpofredc lpofredc commented Jan 3, 2024

Description

The purpose of this pull request is to integrate sensitive module notices into GeoTrek documentation.

Related Issue

#3876

Checklist

  • I have followed the guidelines in our Contributing document
  • My code respects the Definition of done available in the Development section of the documentation
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes
  • I added an entry in the changelog file
  • My commits are all using prefix convention (emoji + tag name) and references associated issues
  • I added a label to the PR corresponding to the perimeter of my contribution
  • The title of my PR mentionned the issue associated

Copy link
Member

@babastienne babastienne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your much needed contribution to the documentation ! 🙏

Few comments :

  • For three files (authors.po changelog.po and install.po), I'm not sure why you put them in the PR as I don't see any modification ? Also it is a good practice to add the parameter --no-location when you run the makemessages command in order to avoid having all the line number modifications.
  • I added some context / few minor corrections. It it suits you don't hesitate to commit them and regenerate the translations accordingly.
  • I'm in doubt about the organisation of the files. Why did you move this documentation in the "user manual" section ? It seems to me that information about API and import data is quite technical, don't you think ? And I have the feeling that the information is separated in two pages but still quite the same as there will be information about the procedure to import data on one page and the details about the data format on another. (maybe @camillemonchicourt can give us his pov ?)
  • I think if we talk about importing data, we should mention at least the possiblity to import all data directly from network. I added a suggestion in this regard.

docs/install/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
docs/install/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
docs/usage/sensitivity.rst Outdated Show resolved Hide resolved
@camillemonchicourt
Copy link
Member

Yes it should grouped in one section, certainly Import, and it is not to go into User manual, but rather in technical parts for administrators.

@babastienne babastienne changed the title [DOC] sensitivity module (refs #3876) Imrpvoe documentation for sensitivity module (refs #3876) Jan 4, 2024
@marcantoinedupre marcantoinedupre changed the title Imrpvoe documentation for sensitivity module (refs #3876) Improve documentation for sensitivity module (refs #3876) Jan 5, 2024
Copy link

cypress bot commented May 30, 2024

Passing run #9093 ↗︎

0 22 0 0 Flakiness 0

Details:

Merge 7c937ee into c7475d5...
Project: Geotrek-admin Commit: b7c3472d36 ℹ️
Status: Passed Duration: 02:04 💡
Started: May 30, 2024 1:17 PM Ended: May 30, 2024 1:19 PM

Review all test suite changes for PR #3877 ↗︎

@lpofredc
Copy link
Contributor Author

Documentation revue et restructurée:

  • Activation du module dans docs/install/advanced-configuration.rst
  • Import des données (soit depuis BiodivSports soit depuis un shapefile) dans docs/install/import.rst
  • Utilisation de l'API dans docs/usage/apis.rst

@babastienne babastienne requested a review from bruhnild May 30, 2024 15:35
lpofredc and others added 2 commits May 30, 2024 18:04
docs/install/import.rst Outdated Show resolved Hide resolved
docs/install/import.rst Outdated Show resolved Hide resolved
docs/install/import.rst Outdated Show resolved Hide resolved
docs/install/import.rst Outdated Show resolved Hide resolved
docs/install/import.rst Outdated Show resolved Hide resolved
docs/usage/apis.rst Outdated Show resolved Hide resolved
docs/usage/apis.rst Outdated Show resolved Hide resolved
docs/usage/apis.rst Outdated Show resolved Hide resolved
docs/usage/apis.rst Outdated Show resolved Hide resolved
docs/usage/apis.rst Outdated Show resolved Hide resolved
@lpofredc lpofredc changed the title Improve documentation for sensitivity module (refs #3876) [DOCUMENTATION] Improve documentation for sensitivity module (refs #3876) May 30, 2024
lpofredc and others added 21 commits May 30, 2024 22:07
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
@lpofredc
Copy link
Contributor Author

@babastienne, @bruhnild, is there any new missing requirements for that PR or could it be merged?

Copy link
Member

@babastienne babastienne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good

@babastienne babastienne changed the title [DOCUMENTATION] Improve documentation for sensitivity module (refs #3876) Improve documentation for sensitivity module (refs #3876) Aug 26, 2024
@babastienne babastienne merged commit a4ffa04 into GeotrekCE:master Aug 26, 2024
1 check passed
@babastienne
Copy link
Member

babastienne commented Aug 26, 2024

Thanks for your contribution @lpofredc, this pull request has been merged.

The official documentation will be updated with your changes when we'll release the next version of Geotrek.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants