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 copywriting for Installation #300

Closed
wants to merge 7 commits into from
Closed

Conversation

verbman
Copy link
Contributor

@verbman verbman commented May 13, 2024

Training Review of Documentation, Part Installation.
(https://openfisca.org/doc/installation/index.html)

@verbman verbman requested review from MattiSG and benjello May 14, 2024 09:04
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

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

Nice improvements, thanks!
This incremental rewrite should not make us forget about #260 that should still be included, though 🙂

@@ -41,12 +41,14 @@ A version number should be printed, and no error message should appear. Congrats

## 3. Install OpenFisca

For this example, we will utilise the `OpenFisca-France` package. For a different model you could achieve the same result by following the [offline environment](offline-environment) example to get local copies of the required packages.
Copy link
Member

Choose a reason for hiding this comment

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

Our goal is to only refer to the Country Template, not to any specific country package.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the review and feedback. I note that this specific example for windows no administration needs to be retried utilising the latest country template. It was originally written against the France model and I would like to leave it in that state for accuracy until there's time to test and write an updated solution.

source/installation/test_situations.md Outdated Show resolved Hide resolved
source/installation/offline-environment.md Outdated Show resolved Hide resolved
@MattiSG MattiSG changed the title Installationmd Improve copywriting for Installation May 14, 2024
verbman and others added 2 commits May 19, 2024 19:26
Co-authored-by: Matti Schneider <matti.schneider@openfisca.fr>
Co-authored-by: Matti Schneider <matti.schneider@openfisca.fr>
@verbman
Copy link
Contributor Author

verbman commented May 20, 2024

Thank you for your reviews. I've opted to now close this pull request and have incorporated the suggested changes into a new Pull Request #306 that also incorporates the previous work on this section in #260.

@verbman verbman closed this May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants