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: Updates install notes for one-liner #2269

Closed
wants to merge 2 commits into from

Conversation

samueldr
Copy link
Member

@samueldr samueldr commented Jul 3, 2018

The previous instructions did not account for the fact that:

  • macOS now defaults to multi-user.
  • it is possible to override installation type.

Furthermore, older commented-out deb/rpm instructions were removed as they are code-rotting.

I think this should be safe to also merge in maintenance (hoping this would also reach the website).


@grahamc please review for the details about the single/multi user installation.


There is one issue which I'm still looking into: will the <segmentedlist> cause issues on the website. I will update this PR once determined. If it does, I will either change to whatever a docbook-knowing contributor suggests, and/or fix the CSS for the website manual accordingly. See my following comment.

These instructions may have worked (but were unsupported) for the 1.x
series of Nix, but definitely cannot work for the 2.0 series.

When/if another deb/rpm version is released in the future, it may be
best to completely re-write the section instead of shoe-horning it into
the older instructions.
The previous instructions did not account for the fact that:

  * macOS now defaults to *multi-user*.
  * it is possible to override installation type.
@grahamc
Copy link
Member

grahamc commented Jul 3, 2018

From the outset lgtm, I'll test it against the website soon.

@samueldr
Copy link
Member Author

samueldr commented Jul 3, 2018

image

Looks fine, the table outputs as expected from a bootstrapified doc.

For the record, I generated it this way:

diff --git a/Makefile b/Makefile
index 5e83ef9..fd982c0 100644
--- a/Makefile
+++ b/Makefile
@@ -52,7 +52,7 @@ $(NIX_PILLS_MANUAL_IN):
 ### Prettify the Nix manual.
-NIX_MANUAL_IN = nix/manual-raw
+NIX_MANUAL_IN = /Users/samuel/tmp/nix/doc/manual
 NIX_MANUAL_OUT = nix/manual
 ifneq ($(wildcard $(NIX_MANUAL_IN)),)

It may be needed to rm -rf nix/manual in your nixos-homepage checkout if it doesn't want to generate.

@grahamc
Copy link
Member

grahamc commented Jul 4, 2018

Nice! LGTM! +1 on backport.

@domenkozar
Copy link
Member

This needs rebasing.

@abathur
Copy link
Member

abathur commented Nov 10, 2020

I think this can be closed.

A quick spot-check suggests:

  • most of these changes are represented in some form in the current document
  • I see a few factual things that have changed
  • It would need to track docbook -> markdown

@samueldr samueldr closed this Nov 10, 2020
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.

None yet

4 participants