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

doc: enable documentation generation on RHEL with asciidoc #718

Merged
merged 1 commit into from
Jan 18, 2025

Conversation

yarda
Copy link
Contributor

@yarda yarda commented Dec 11, 2024

With this patch the documentation will be also generated on RHEL with now obsoleted asciidoc tool. The styling is a bit lame, but it's usable.

@yarda yarda requested a review from zacikpa January 16, 2025 21:01
@zacikpa
Copy link
Contributor

zacikpa commented Jan 17, 2025

Cool! I think the asciidoc style is timeless :)

What's worse is that it cannot handle syntax such as [option]`skip_grub_config=VALUE`. TBH, I'm not sure what's the purpose of those in the manual anyway. Is that used in Red Hat product docs?

@yarda
Copy link
Contributor Author

yarda commented Jan 17, 2025

Cool! I think the asciidoc style is timeless :)

What's worse is that it cannot handle syntax such as [option]skip_grub_config=VALUE. TBH, I'm not sure what's the purpose of those in the manual anyway. Is that used in Red Hat product docs?

I don't know :). In the worst case we could drop it. Is it causing any problem now?

@zacikpa
Copy link
Contributor

zacikpa commented Jan 17, 2025

It displays literally when compiled by asciidoc:
image

@yarda
Copy link
Contributor Author

yarda commented Jan 17, 2025

It displays literally when compiled by asciidoc:

I think it's OK. It's the price for cross compatibility. On RHEL the reader could see the meta marks which could help her/him to better understand the text and on Fedora it will be nicely formatted. Also, later in RHEL, when they switch to up-to-date asciidoc tooling, it will be nicely formatted. IMHO in RHEL, there is some tooling improvement planned, but it could take a long time. I think it's better to have the asciidoc in the meantime at least.

@zacikpa
Copy link
Contributor

zacikpa commented Jan 17, 2025

Agreed.

@yarda yarda merged commit dee3b40 into redhat-performance:master Jan 18, 2025
12 of 14 checks passed
@yarda yarda deleted the rhel_enable_docs branch January 18, 2025 18:55
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

Successfully merging this pull request may close these issues.

2 participants