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

Convert mkShell from Docbook to CommonMark #105757

Closed
ryantm opened this issue Dec 3, 2020 · 2 comments
Closed

Convert mkShell from Docbook to CommonMark #105757

ryantm opened this issue Dec 3, 2020 · 2 comments
Projects
Conversion to CommonMark Docs

Comments

@ryantm
Copy link
Member

ryantm commented Dec 3, 2020

This issue tracks the conversion of /doc/builders/special/mkshell.xml from Docbook to CommonMark per RFC 72.

If you intend to work on this conversion, please comment below!

Conversion instructions

  1. Comment here that you intend to work on it. (Please also post if you stop working on it.)
  2. Checkout a new branch of nixpkgs master.
  3. Edit doc/builders/special.xml: change mkshell.xml to mkshell.section.xml.
  4. Rename doc/builders/special/mkshell.xml to mkshell.section.md.
  5. Convert the contents from Docbook to CommonMark. Follow conversion best practices. Use existing .md sections for inspiration.
  6. Use nix-build from the doc/ folder to build the manual.
  7. Preview the manual on your computer at http://0.0.0.0:8000/manual.html after running from doc/ folder:
nix-shell -p python3 --run 'python3 -m http.server --directory ./result/share/doc/nixpkgs'
  1. When it looks good, submit a PR and reference this issue.
@AndersonTorres
Copy link
Member

I'm in!

@ryantm ryantm moved this from To do to In progress in Conversion to CommonMark Docs Dec 8, 2020
@AndersonTorres
Copy link
Member

#106845

@AndersonTorres AndersonTorres mentioned this issue Dec 13, 2020
Merged
10 tasks
@jtojnar jtojnar closed this as completed Dec 17, 2020
@jtojnar jtojnar moved this from In progress to Done (add to next Discourse update) in Conversion to CommonMark Docs Dec 17, 2020
@ryantm ryantm moved this from Done (add to next Discourse update) to Done (mentioned on Discourse) in Conversion to CommonMark Docs Dec 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Conversion to CommonMark Docs
Done (mentioned on Discourse)
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ryantm @jtojnar @AndersonTorres