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/pantheon: add docs #80451

Merged
merged 1 commit into from Mar 1, 2020
Merged

Conversation

worldofpeace
Copy link
Contributor

Motivation for this change

I finally translated the docs I wrote for Pantheon in markdown months ago 🎊
https://gist.github.com/worldofpeace/27fcdcb111ddf58ba1227bf63501a5fe

There's one thing I couldn't translate and it's the cool citation/reference [^1], which in markdown would give you a nice hover text and citation at the end of the section (clickable link).

Things done

Manual was built.

  • 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.

@worldofpeace worldofpeace added the 9.needs: port to stable A PR needs a backport to the stable release. label Feb 18, 2020
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
<title>Wingpanel and Switchboard plugins</title>

<para>
Wingpanel and Switchboard work differently than they do in other distributions, as far as using plugins.
Copy link
Contributor

Choose a reason for hiding this comment

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

missing verb?

nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
nixos/modules/services/x11/desktop-managers/pantheon.xml Outdated Show resolved Hide resolved
@worldofpeace
Copy link
Contributor Author

@jtojnar I wasn't sure how to link into the nixpkgs manual for the overrides.

@worldofpeace
Copy link
Contributor Author

I also wasn't sure about plugins vs plug-ins. I see a lot of docs with plugins and I almost always use this spelling.

@worldofpeace worldofpeace merged commit 0bbada3 into NixOS:master Mar 1, 2020
@worldofpeace worldofpeace deleted the pantheon-doc branch March 1, 2020 16:57
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

2 participants