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

Replace ronn with pandoc #829

Closed
tnir opened this issue Jul 31, 2022 · 8 comments
Closed

Replace ronn with pandoc #829

tnir opened this issue Jul 31, 2022 · 8 comments
Assignees
Labels
architecture/legacy or broken Legacy and/or broken architecture

Comments

@tnir
Copy link
Collaborator

tnir commented Jul 31, 2022

The urrent .ronn files in https://github.com/rubygems/rubygems/tree/master/bundler/lib/bundler/man are almost (common) Markdown while its extension is ronn, and so we might be able to use pandoc to do the same thing with less additional effort.

For example, ronn parses h1 markup incorrectly, so we need some workaround for it. ronn has not been maintained for 9 years.

cf.

@tnir tnir added the architecture/legacy or broken Legacy and/or broken architecture label Jul 31, 2022
@tnir tnir added this to the Architecture overhaul milestone Jul 31, 2022
@indirect
Copy link
Member

Ronn is at least written in ruby, while pandoc is 1) huge and 2) pandoc filters add python as a build dependency, which will greatly increase future maintenance burden. I would strongly prefer fixing the bug in ronn rather than adding the entire python ecosystem into this repo.

@simi
Copy link
Member

simi commented Jul 31, 2022

Btw. there is https://github.com/apjanke/ronn-ng, we can try migrate in there and help maintain that one if needed.

@tnir
Copy link
Collaborator Author

tnir commented Jul 31, 2022

ronn-ng gem, mentioned by @deivid-rodriguez before, also looks unmaintained any more to me.

@simi
Copy link
Member

simi commented Jul 31, 2022

@tnir we can help with maintenance. Is there anything particular to address for now?

@tnir
Copy link
Collaborator Author

tnir commented Aug 1, 2022

As an alternative, you might want to check out pandoc which can also convert markdown into roff manual pages.

Ronn-NG also recommends using pandoc.

@simi take a look at #823

@simi
Copy link
Member

simi commented Aug 1, 2022

As an alternative, you might want to check out pandoc which can also convert markdown into roff manual pages.

Ronn-NG also recommends using pandoc.

🤔 It doesn't, it just mentions it as an alternative, which is just copy paste from original ronn repository README.

@deivid-rodriguez
Copy link
Member

Should we close this issue? I think everyone agrees to stick with a Ruby based library. Good old ronn has served us well for more than 10 years without a single upstream patch, this doesn't look like a domain that changes very often and needs a lot of maintenance.

@tnir
Copy link
Collaborator Author

tnir commented Dec 31, 2022

I think we do not have to do this in this repo in favor of #996.

@tnir tnir closed this as not planned Won't fix, can't repro, duplicate, stale Dec 31, 2022
@tnir tnir self-assigned this Dec 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture/legacy or broken Legacy and/or broken architecture
Projects
None yet
Development

No branches or pull requests

4 participants