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

manual: Contributing -> Development, Hacking -> Building #9014

Merged
merged 5 commits into from
Jul 25, 2024

Conversation

fricklerhandwerk
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk commented Sep 20, 2023

Motivation

what's currently called "hacking" are really instructions for setting up
a development environment and compiling from source. we have
a contribution guide in the repo (which rightly focuses on GitHub
workflows), and the material in the manual is more about working
on the code itself.

Context

we may want to reorganise this in the future, and bring
contributor-oriented information closer to the code, but for now let's
stick to more accurate names to ease navigation.

This work is sponsored by Antithesis

Priorities

Add 👍 to pull requests you find important.

@Ericson2314
Copy link
Member

I would call "compiling" "building". "compiling" is a weird word (fun fact, the original "compiler" was actually a linker, and the original meaning of the English word is much better suited for that rather than "translating" which it doesn't meant at all). "compilation" in today's jargon sense is also just once part of the build process too.

It is confusing when the titles and TOC are changed but the file names are are not.

@cole-h
Copy link
Member

cole-h commented Sep 21, 2023

I think changing the filenames to match whatever heading is decided on would be fine, if there are redirects for the old pages put in place. I personally navigate directly to the hacking page using my browser's history, and hitting a 404 would be a little jarring.

@Ericson2314
Copy link
Member

We've done redirects in the past no problem

@fricklerhandwerk
Copy link
Contributor Author

fricklerhandwerk commented Sep 21, 2023

I would call "compiling" "building".

Then we'd have three headings on that page that say "building".

@Ericson2314 moved the "classic Nix" instructions to the top to avoid that. Please check again.

@cole-h we won't have the redirects problem soon-ish, and for now I wouldn't change the file names as that will just produce more work that won't age well.

@fricklerhandwerk fricklerhandwerk changed the title manual: Contributing -> Development, Hacking -> Compiling manual: Contributing -> Development, Hacking -> Building Sep 25, 2023
Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

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

Unfortunately nix-shell doesn't work so well because it doesn't set as many configure flags pertenaining to output dirs. I therefore use nix develop to work on Nix even though I use nix-shell for all other tasks.

The headings look good now, but I still really want the file names to match the heading names. Otherwise I have trouble finding what I am looking for.

@fricklerhandwerk
Copy link
Contributor Author

fricklerhandwerk commented Nov 27, 2023

Blocked by #9459 and NixOS/nix.dev#764, as I don't want to ever deal with the redirect synchronisation nonsense again.

@fricklerhandwerk fricklerhandwerk marked this pull request as draft November 27, 2023 12:43
what's currently called "hacking" are really instructions for setting up
a development environment and compiling from source. we have
a contribution guide in the repo (which rightly focuses on GitHub
workflows), and the material in the manual is more about working
on the code itself.

since we'd otherwise have three headings that amount to "Building Nix",
this change also moves the "classic Nix" instructions to the top.

we may want to reorganise this in the future, and bring
contributor-oriented information closer to the code, but for now let's
stick to more accurate names to ease navigation.
@github-actions github-actions bot added new-cli Relating to the "nix" command contributor-experience Developer experience for Nix contributors labels Jun 11, 2024
@fricklerhandwerk fricklerhandwerk marked this pull request as ready for review June 13, 2024 09:58
@fricklerhandwerk
Copy link
Contributor Author

It's become a lot more convoluted with the redirects now, and I can't guarantee that nothing will break, but I'll be available for fixing the mess I produce if someone complains.

@fricklerhandwerk fricklerhandwerk enabled auto-merge (squash) July 25, 2024 02:03
@fricklerhandwerk fricklerhandwerk merged commit a2fed6d into NixOS:master Jul 25, 2024
12 checks passed
Mic92 pushed a commit to Mic92/nix-1 that referenced this pull request Jul 25, 2024
Arose because NixOS#9014 merged before
NixOS#11131, but the latter did not rebase /
merge against the latest master.
rhendric pushed a commit to rhendric/nix that referenced this pull request Jul 25, 2024
Arose because NixOS#9014 merged before
NixOS#11131, but the latter did not rebase /
merge against the latest master.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor-experience Developer experience for Nix contributors documentation new-cli Relating to the "nix" command
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants