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
Migrate README.md to quarkiverse-docs #213
Comments
Signed-off-by: Helber Belmiro <helber.belmiro@gmail.com>
@ricardozanini @hbelmiro If this is still needed maybe I can take a look. |
Yes. It's still needed, but I don't know if you have enough privileges. |
@TheJavaGuy @hbelmiro we do not require any special privileges, just migrate the README to the docs directory and open a PR here. Thank you very much @TheJavaGuy. This would be a must for the community. :) |
@ricardozanini @hbelmiro This is being labeled as Stale. |
Hey @hbelmiro @ricardozanini just to say that I didn't forget about this one, just I've been busy with fixing asciidoc errors in other extensions. But that should be done soon so I'll get back to this issue. |
Instead of keeping our documentation in the README file, we should migrate it to Asciidoc and publish it in the Quarkiverse Documentation: https://quarkiverse.github.io/quarkiverse-docs/index/index/index.html.
It will help maintain it across the different versions and also with SEO.
See how to do it: https://github.com/quarkiverse/quarkiverse/wiki#documenting-your-extension
The text was updated successfully, but these errors were encountered: