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

fix up language in the packaging tutorial #887

Merged
merged 10 commits into from
Feb 7, 2024

Conversation

fricklerhandwerk
Copy link
Collaborator

  • make many sentences shorter
  • add links
  • expand on finding things
  • use more domain-specific headings
  • add next steps

Copy link
Contributor

@henrik-ch henrik-ch left a comment

Choose a reason for hiding this comment

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

I couldn't complete all the way down - thank you for putting in this work @fricklerhandwerk ! ❤️

source/tutorials/first-steps/declarative-shell.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
fricklerhandwerk and others added 5 commits January 30, 2024 13:39
- make many sentences shorter
- add links
- expand on finding things
- use more domain-specific headings
- add next steps
Co-authored-by: Henrik <i97henka@gmail.com>
Co-authored-by: Henrik <i97henka@gmail.com>
Co-authored-by: Henrik <i97henka@gmail.com>
Copy link
Contributor

@oliviacrain oliviacrain left a comment

Choose a reason for hiding this comment

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

I went through the first half of the changes, and will try to get to the second half in a few hours.

As is, this PR greatly improves the readability of the tutorial, so please feel free to ignore any comments that are too nit-picky!

source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
@@ -179,7 +214,7 @@ building
Great news: the derivation built successfully!

The console output shows that `configure` was called, which produced a `Makefile` that was then used to build the project.
It wasn't necessary to write any build instructions in this case because the `stdenv` build system is based on `autoconf`, which automatically detected the structure of the project directory.
It wasn't necessary to write any build instructions in this case because the `stdenv` build system is based on [GNU Autoconf](https://www.gnu.org/software/autoconf/), which automatically detected the structure of the project directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this sentence implies autoconf itself detected the structure of the project, which is incorrect.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

What would you suggest here?

Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

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

Overall looking good, left some minor suggestions

source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
source/tutorials/packaging-existing-software.md Outdated Show resolved Hide resolved
fricklerhandwerk and others added 3 commits February 2, 2024 01:30
Co-authored-by: Olivia Crain <olivia@olivia.dev>
Co-authored-by: Silvan Mosberger <github@infinisil.com>
Co-authored-by: Olivia Crain <olivia@olivia.dev>
@fricklerhandwerk
Copy link
Collaborator Author

Thanks a lot @oliviacrain for the great, diligent review comments! I think we can leave the last one for now and fix it later.

@fricklerhandwerk fricklerhandwerk merged commit 53cbd11 into NixOS:master Feb 7, 2024
5 checks passed
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.

Consider explaining "searching for packages" more detailed
4 participants