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

nixos/doc: Rudimentary documentation for Subversion-inside-Apache HTTP. #78168

Merged
merged 1 commit into from Nov 21, 2020
Merged

nixos/doc: Rudimentary documentation for Subversion-inside-Apache HTTP. #78168

merged 1 commit into from Nov 21, 2020

Conversation

mikesperber
Copy link
Contributor

Content thanks to: Aaron Andersen

Motivation for this change

I couldn't figure out how to set up a Subversion WebDAV server. Aaron Anderson provided beautiful instructions, and I turned it into a documentation section.

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.

@nixos-discourse
Copy link

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

https://discourse.nixos.org/t/how-to-set-up-subversion-http-server/5503/5

nixos/doc/manual/configuration/subversion.xml Outdated Show resolved Hide resolved
nixos/doc/manual/configuration/subversion.xml Outdated Show resolved Hide resolved
nixos/doc/manual/configuration/subversion.xml Outdated Show resolved Hide resolved
nixos/doc/manual/configuration/subversion.xml Outdated Show resolved Hide resolved
@aanderse
Copy link
Member

aanderse commented Apr 29, 2020

You will need to rebase on master. Also, this may be more appropriate as a wiki article on the NixOS wiki.

@mikesperber
Copy link
Contributor Author

Rebased off master. Someone else needs to decide where it goes. I thought the idea was to move stuff off the wiki and onto maintained documentation?

@stale
Copy link

stale bot commented Oct 30, 2020

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Oct 30, 2020
@mikesperber
Copy link
Contributor Author

This is kind of a bummer - it's s straightforward contribution, and I've been responsive to comments.

@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Oct 30, 2020
@aanderse
Copy link
Member

@mikesperber you're very right. I'll review this again, familiarize myself with the documentation format, and merge it in the next few days. I'm very sorry for the delay.

Maybe @Ma27 could find a few spare minutes to help me out by looking for any documentation format issues.
Maybe @davidak could find a few spare minutes to look over the wording and see if there are any suggestions.

Copy link
Member

@aanderse aanderse left a comment

Choose a reason for hiding this comment

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

I wonder if the example would benefit from showing actual values instead of ... 🤔

@mikesperber
Copy link
Contributor Author

I've revised the patch, but I want to verify it all works with the current NixOS tomorrow, when I have access to the physical machine. Please hold off re-review until then.

@mikesperber
Copy link
Contributor Author

@aanderse Done. Also checked the instructions against a fresh NixOS 20 install. Could you take another look?

Copy link
Member

@aanderse aanderse left a comment

Choose a reason for hiding this comment

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

Took a quick look. Will render this and view it to give a more full review shortly. Looking good though. Thanks!

nixos/doc/manual/configuration/subversion.xml Outdated Show resolved Hide resolved
@aanderse
Copy link
Member

@mikesperber the EditorConfig check is failing due to trailing whitespace in subversion.xml. Aside from that I think this looks good 👍

@Ma27 do you mind taking one more quick look, reading this over and making sure it works for you? The knowledge is a bit httpd specific, but just fake your way through that if you need to and make sure you're happy 😄

@mikesperber
Copy link
Contributor Author

@AndersE Zapped the whitespace. Again, thanks!

@aanderse
Copy link
Member

@mikesperber I hope this isn't getting too tiring for you... now the validation fails because it wants spaces, not tabs.

Thanks again for your patience on this.

@mikesperber
Copy link
Contributor Author

@aanderse I hope it isn't getting too tiring for you. :-) Replaced the tabs by spaces.

@aanderse aanderse merged commit 30c2069 into NixOS:master Nov 21, 2020
@aanderse
Copy link
Member

Thank you for your contribution and patience!

@mikesperber
Copy link
Contributor Author

@aanderse Thanks for the review & your patience!

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

Successfully merging this pull request may close these issues.

None yet

4 participants