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 ocitools from Docbook to CommonMark #105760

Closed
ryantm opened this issue Dec 3, 2020 · 1 comment · Fixed by #108917
Closed

Convert ocitools from Docbook to CommonMark #105760

ryantm opened this issue Dec 3, 2020 · 1 comment · Fixed by #108917

Comments

@ryantm
Copy link
Member

ryantm commented Dec 3, 2020

This issue tracks the conversion of /doc/builders/images/ocitools.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/images.xml: change ocitools.xml to ocitools.section.xml.
  4. Rename doc/builders/images/ocitools.xml to ocitools.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.
@bryanasdev000
Copy link
Member

Hi @ryantm!

Already opened a PR for that (#108917).

@ryantm ryantm moved this from To do to Needs review in Conversion to CommonMark Docs Apr 1, 2021
@ryantm ryantm moved this from Needs review to Done (add to next Discourse update) in Conversion to CommonMark Docs Apr 1, 2021
@ryantm ryantm moved this from Done (add to next Discourse update) to Done (mentioned on Discourse) in Conversion to CommonMark Docs Jun 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Conversion to CommonMark Docs
Done (mentioned on Discourse)
Development

Successfully merging a pull request may close this issue.

2 participants