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

Discuss DocBook to CommonMark transition #23

Closed
ryantm opened this issue Dec 8, 2020 · 5 comments
Closed

Discuss DocBook to CommonMark transition #23

ryantm opened this issue Dec 8, 2020 · 5 comments

Comments

@ryantm
Copy link
Collaborator

ryantm commented Dec 8, 2020

Hi!

It recently came to my attention that this project is used in the nixpkgs manual. We've recently accepted a community proposal to change the manual from DocBook to CommonMark and are working on transitioning.. We are changing one section from DocBook to CommonMark at a time. Until we're done, we are using Pandoc to convert them back to DocBook for inclusion into the manual.

I am opening this issue to discuss if it makes sense to convert this library to output CommonMark instead of Docbook. Or, maybe it makes sense to use some other tool. Any advice would be appreciated.

- Ryan

@roberth
Copy link
Contributor

roberth commented May 29, 2021

Nixpkgs' choice for markdown makes the choice for markup in comments (#5) a no-brainer.

@tazjin
Copy link
Contributor

tazjin commented May 29, 2021

if it makes sense to convert this library to output CommonMark instead of Docbook

That's probably reasonable! Depending on the structure you're opting for it's likely much easier than the current docbook generation step.

I've moved this repository over to the nix-community organisation, and it's maintained by the docs team there - feel free to join if you're interested, especially because I don't know how much time I have for this at the moment (likely not much).

@fricklerhandwerk
Copy link
Contributor

@mightyiam I think this should be a straightforward first step to continue with the markdown migration.

@fricklerhandwerk fricklerhandwerk moved this from Agenda to Open in Nix documentation Oct 27, 2022
@olafklingt olafklingt moved this to TODO Infrastructure in Nix documentation Mar 12, 2023
@asymmetric
Copy link
Contributor

This has been closed by #25.

@tazjin tazjin closed this as completed Mar 23, 2023
@github-project-automation github-project-automation bot moved this from Topic: Infrastructure to ⏰ Postponed in Nix documentation Mar 23, 2023
@mightyiam
Copy link
Contributor

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants