Skip to content

nixos/kanidm: fix broken doc links#252524

Merged
erictapen merged 1 commit intoNixOS:masterfrom
tuxiqae:patch-2
Aug 31, 2023
Merged

nixos/kanidm: fix broken doc links#252524
erictapen merged 1 commit intoNixOS:masterfrom
tuxiqae:patch-2

Conversation

@tuxiqae
Copy link
Copy Markdown
Contributor

@tuxiqae tuxiqae commented Aug 31, 2023

Description of changes

Fix broken Kanidm docs links, also use documentation portal instead of links to MD pages in GH

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Aug 31, 2023
@tuxiqae
Copy link
Copy Markdown
Contributor Author

tuxiqae commented Aug 31, 2023

Wasn't sure what to tick since I only made changes to option descriptions.

@nagy
Copy link
Copy Markdown
Member

nagy commented Aug 31, 2023

Thanks, can you follow the guidelines for the commit message at https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions ?

@tuxiqae
Copy link
Copy Markdown
Contributor Author

tuxiqae commented Aug 31, 2023

@nagy Fixed (?)

@nagy
Copy link
Copy Markdown
Member

nagy commented Aug 31, 2023

Since it is a nixos module it needs the prefix. I would suggest nixos/kanidm: fix broken doc links. Also the PR title should be the same, if you only have this one commit.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Aug 31, 2023
@tuxiqae tuxiqae changed the title Fix broken Kanidm documentation links nixos/kanidm: fix broken doc links Aug 31, 2023
@tuxiqae
Copy link
Copy Markdown
Contributor Author

tuxiqae commented Aug 31, 2023

@nagy

@nagy nagy requested review from Flakebi and erictapen August 31, 2023 12:09
Copy link
Copy Markdown
Member

@Flakebi Flakebi 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!
Looks obviously good to me

Copy link
Copy Markdown
Member

@erictapen erictapen left a comment

Choose a reason for hiding this comment

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

Thanks!

@github-actions
Copy link
Copy Markdown
Contributor

Successfully created backport PR for release-23.05:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants