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.

Sign up for GitHub

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

doc: convert weechat docs to commonmark #105322

Merged
merged 1 commit into from Dec 1, 2020
Merged

doc: convert weechat docs to commonmark #105322

merged 1 commit into from Dec 1, 2020

Conversation

fzakaria
Copy link
Contributor

Motivation for this change

This is essentially an automatic pandoc conversion of the weechat
section in docbook as part of the larger CommonMark Docs project

I generated the resulting documentation and verified it looks correct to what was previously present at https://nixos.org/manual/nixpkgs/unstable/#sec-weechat

I also followed #105243 by running prettier on the commonmark generated.

image

fixes #105264

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.

@ryantm

@fzakaria
Copy link
Contributor Author

@ryantm i'm curious why the CSS layout of what I generate looks so different than the nixos.org styles?
It was much more narrow

image

@jonringer
Copy link
Contributor

i'm curious why the CSS layout of what I generate looks so different than the nixos.org styles

nixos.org uses it's own style sheets

@fzakaria fzakaria requested a review from FRidh November 30, 2020 04:34
@fzakaria @jtojnar
doc: convert weechat docs to commonmark
aa74930 
This is essentially an automatic pandoc conversion of the weechat
section in docbook as part of the larger CommonMark Docs project
(https://github.com/NixOS/nixpkgs/projects/37)

fixes NixOS#105264

Update doc/builders/packages/weechat.section.md

Co-authored-by: Frederik Rietdijk <freddyrietdijk@fridh.nl>

Update doc/builders/packages/weechat.section.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
ryantm
ryantm approved these changes Dec 1, 2020
View reviewed changes
Copy link
Member

@ryantm ryantm left a comment

Choose a reason for hiding this comment

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

Source and rendered looks good!

@ryantm ryantm merged commit 6c407c7 into NixOS:master Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ryantm ryantm ryantm approved these changes

@FRidh FRidh Awaiting requested review from FRidh

@jtojnar jtojnar Awaiting requested review from jtojnar

Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert Weechat from Docbook to CommonMark
5 participants
@fzakaria @jonringer @ryantm @jtojnar @FRidh