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 #306

Merged
merged 30 commits into from
May 21, 2024
Merged

Improve copywriting for Installation #306

merged 30 commits into from
May 21, 2024

Conversation

verbman
Copy link
Contributor

@verbman verbman commented May 20, 2024

This pull request completes the work done by @sandcha on the Installation (now Getting started) section and incorporates the changes suggested in the now superseded PR 300 which I will close (thank you to those who reviewed that). I have also renamed files and reordered the section. I appreciate this constitutes a larger Pull Request than I might have hoped for.
I believe this should not be merged until #299 has been accepted.

@MattiSG MattiSG requested review from sandcha and removed request for sandcha May 20, 2024 20:46
@MattiSG
Copy link
Member

MattiSG commented May 20, 2024

Thanks @verbman for reviving #260!

This PR seems to contain a changeset way bigger than necessary. I see that all the original commits are still present, on top of the rebased ones. Do you need operating the rebase? 🙂

@MattiSG
Copy link
Member

MattiSG commented May 20, 2024

Once you are sure that your suggested diff contains only the updated installation instructions, please request review from @sandcha.

@MattiSG MattiSG changed the title Improve copywriting for Installation (take 2) Improve copywriting for Installation May 20, 2024
@verbman verbman requested review from sandcha and MattiSG May 21, 2024 04:51
Copy link
Contributor

@sandcha sandcha left a comment

Choose a reason for hiding this comment

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

Thank you very much for this update 💞
I'm approving the PR; nevertheless you will find some comments and it might still be interesting to include what is said on:

  • source/installation/access-countrys-source-code.md to explain that contributors need to install the source code with SSH,
  • source/installation/installation-requirements.md for windows users as they can now use pip,
  • source/installation/windows-no-admin.md because the broken link is easy to fix.

source/installation/access-countrys-source-code.md Outdated Show resolved Hide resolved
source/installation/call-existing-web-api.md Outdated Show resolved Hide resolved
source/installation/call-existing-web-api.md Outdated Show resolved Hide resolved
source/installation/index.md Outdated Show resolved Hide resolved
source/installation/installation-requirements.md Outdated Show resolved Hide resolved
source/installation/installation-requirements.md Outdated Show resolved Hide resolved
source/installation/windows-no-admin.md Outdated Show resolved Hide resolved
source/installation/windows-no-admin.md Show resolved Hide resolved
@MattiSG MattiSG removed their request for review May 21, 2024 19:03
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.

I don't have time to review the contents and trust that two trusted senior contributors reviewing content that was originally written some time ago by @sandcha but that I had fully reviewed is more than enough! I thus dismiss my request for review and let @verbman include whichever feedback he deems relevant and merge 🎉

@verbman verbman merged commit 07639df into master May 21, 2024
3 checks passed
@verbman verbman deleted the update-default-install branch May 21, 2024 23:30
@MattiSG MattiSG linked an issue May 22, 2024 that may be closed by this pull request
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.

Update installation instructions
3 participants