-
Notifications
You must be signed in to change notification settings - Fork 803
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
Self-host Ruby API documentation #1011
Comments
Looking forward, I'd really like to bring all the APIs for Asciidoctor under one "roof". Therefore, I'm open to setting up the domain api.asciidoctor.org for this purpose. We'd manage the site on Netlify, like we do the other sites, and it would get its own build. Then we can put any amount of API docs there. |
I guess we would need to create a GitHub repository The build could:
@mojavelinux is that what you have in mind? |
The API documentation for Ruby is available on Rubydoc and is linked from the Asciidoctor documentation:
https://docs.asciidoctor.org/asciidoctor/latest/api/
It's back up today (hurrah!) but is very regularly down at URLs like:
https://www.rubydoc.info/gems/asciidoctor/2.0.16
Sometimes a previous version can be found by modifying the URL.
IMHO we need better uptime and this should not be excessively onerous or complex in 2021 for a static website.
I recommend we generate the documentation ourselves using Yard (which is what Rubydoc uses) in CI and then bundle it into docs.asciidoctor.org to take advantage of the resiliency/redundancy of Netlify.
The text was updated successfully, but these errors were encountered: