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

Jump to bottom

nixos/acme: improve some descriptions #85681

Merged
merged 1 commit into from Jul 23, 2020
Merged

nixos/acme: improve some descriptions #85681

merged 1 commit into from Jul 23, 2020

Conversation

tomcur
Copy link
Contributor

@tomcur tomcur commented Apr 21, 2020

Motivation for this change

In the ACME module documentation: make some links explicit and improve description consistency.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

drewrisinger
drewrisinger reviewed Apr 28, 2020
View reviewed changes
Copy link
Contributor

@drewrisinger drewrisinger left a comment

Choose a reason for hiding this comment

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

Improvements look good to me, though I honestly don't know enough about <link> tags (XML??) to comment on that part.

@tomcur
Copy link
Contributor Author

tomcur commented Apr 28, 2020

@drewrisinger I've not seen documentation on it, but such links are rendered as actual links on e.g. https://nixos.org/nixos/options.html.

@drewrisinger
Copy link
Contributor

Found a random example.

nixpkgs/nixos/modules/security/duosec.nix

Line 75 in 8a061eb

<link xlink:href="https://duo.com/docs/duounix"/> for details.

@drewrisinger
Copy link
Contributor

Looks like your links fit the format, so changing to approval.

drewrisinger
drewrisinger approved these changes Apr 28, 2020
View reviewed changes
Copy link
Contributor

@drewrisinger drewrisinger left a comment

Choose a reason for hiding this comment

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

Link format LGTM based on other examples. Diff LGTM

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/172

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/181

@marsam marsam merged commit af5765b into NixOS:master Jul 23, 2020
@marsam
Copy link
Contributor

marsam commented Jul 23, 2020

Thanks!

@tomcur tomcur deleted the improve-descriptions branch November 9, 2020 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drewrisinger drewrisinger drewrisinger approved these changes

Assignees
No one assigned
Labels
6.topic: nixos 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 10.rebuild-linux: 1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@tomcur @drewrisinger @nixos-discourse @marsam