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

Update manual to reflect newer ruby documentation #95025

Closed
wants to merge 1 commit into from
Closed

Update manual to reflect newer ruby documentation #95025

wants to merge 1 commit into from

Conversation

kamronm
Copy link
Contributor

@kamronm kamronm commented Aug 10, 2020

With the addition of ruby.withPackages, @manveru rewrote the nixpkgs
manual section for the ruby language but did not add it to the manual.
This commit replaces the previous documentation with manveru's updated
version.

Motivation for this change

The updated ruby language section written by @manveru seems to be the most current documentation for using ruby within the Nix ecosystem. Despite being authored almost 10 months ago, it has never been added to the nixpkgs manual visible at nixos.org because it was not added to the index file for the languages and frameworks section. I think it should be.

Changes made
  • Added doc/languages-frameworks/ruby.section.md to doc/languages-frameworks/index.xml
  • Updated headings to resolve error messages over conflicting section ids
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.

With the addition of ruby.withPackages, @manveru rewrote the nixpkgs
manual section for the ruby language but did not add it to the manual.
This commit replaces the previous documentation with manveru's updated
version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Conversion to CommonMark Docs
Done (not a conversion)
Development

Successfully merging this pull request may close these issues.

None yet

3 participants