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

Convert Ocaml from Docbook to Commonmark #104968

Closed
ryantm opened this issue Nov 26, 2020 · 1 comment · Fixed by #105648
Closed

Convert Ocaml from Docbook to Commonmark #104968

ryantm opened this issue Nov 26, 2020 · 1 comment · Fixed by #105648

Comments

@ryantm
Copy link
Member

ryantm commented Nov 26, 2020

This issue tracks the conversion of /doc/languages-frameworks/ocaml.xml from Docbook to Commonmark per RFC 72.

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

Instructions for performing this conversion

  1. Post in this issue 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/languages-frameworks/index.xml: change ocaml.xml to ocaml.section.xml.
  4. Move doc/languages-frameworks/ocaml.xml to doc/languages-frameworks/ocaml.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

Done!
#105648

@ryantm ryantm moved this from To do to In progress in Conversion to CommonMark Docs Dec 3, 2020
@ryantm ryantm linked a pull request Dec 3, 2020 that will close this issue
10 tasks
@ryantm ryantm moved this from In progress to Done (add to next Discourse update) in Conversion to CommonMark Docs Dec 5, 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
Projects
Conversion to CommonMark Docs
Done (mentioned on Discourse)
Development

Successfully merging a pull request may close this issue.

2 participants