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 Gnome from Docbook to CommonMark #104965

Closed
ryantm opened this issue Nov 26, 2020 · 3 comments · Fixed by #105284
Closed

Convert Gnome from Docbook to CommonMark #104965

ryantm opened this issue Nov 26, 2020 · 3 comments · Fixed by #105284
Labels
6.topic: GNOME GNOME desktop environment and its underlying platform

Comments

@ryantm
Copy link
Member

ryantm commented Nov 26, 2020

This issue tracks the conversion of /doc/languages-frameworks/gnome.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 gnome.xml to gnome.section.xml.
  4. Convert the contents from Docbook to CommonMark. Follow conversion best practices. Use existing .md sections for inspiration.
  5. Convert the contents from Docbook to CommonMark. 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.
@ryantm ryantm added the 6.topic: GNOME GNOME desktop environment and its underlying platform label Nov 26, 2020
@ryantm ryantm changed the title Convert Gnome from Docbook to Commonmark Convert Gnome from Docbook to CommonMark Nov 26, 2020
@jtojnar
Copy link
Contributor

jtojnar commented Nov 26, 2020

I can try to tackle this, hopefully we will be able to figure out how to make it functionally equivalent, even if semantic equivalence is out.

@jtojnar
Copy link
Contributor

jtojnar commented Nov 26, 2020

I want to finish #101537 first to avoid conflicts, though.

@Mic92
Copy link
Member

Mic92 commented Nov 28, 2020

This was merged now.

@ryantm ryantm linked a pull request Dec 3, 2020 that will close this issue
@ryantm ryantm moved this from To do to In progress in Conversion to CommonMark Docs Dec 3, 2020
@ryantm ryantm moved this from In progress to Needs review in Conversion to CommonMark Docs Dec 3, 2020
@ryantm ryantm moved this from Needs review to Done (add to next Discourse update) in Conversion to CommonMark Docs Dec 8, 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
Labels
6.topic: GNOME GNOME desktop environment and its underlying platform
Projects
Conversion to CommonMark Docs
Done (mentioned on Discourse)
Development

Successfully merging a pull request may close this issue.

3 participants