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

Migrate README.md to quarkiverse-docs #213

Closed
ricardozanini opened this issue Dec 28, 2022 · 5 comments · Fixed by #493
Closed

Migrate README.md to quarkiverse-docs #213

ricardozanini opened this issue Dec 28, 2022 · 5 comments · Fixed by #493
Labels
added to backlog The issue was added to backlog area:documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed pinned Issues and PRs that must not stale

Comments

@ricardozanini
Copy link
Member

ricardozanini commented Dec 28, 2022

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

@ricardozanini ricardozanini added area:documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Dec 28, 2022
@ricardozanini ricardozanini changed the title Migrate to quarkiverse-docs Migrate README.md to quarkiverse-docs Dec 28, 2022
@hbelmiro hbelmiro added the added to backlog The issue was added to backlog label Dec 28, 2022
hbelmiro added a commit to hbelmiro/issues-i-can-help-you-with that referenced this issue Dec 28, 2022
Signed-off-by: Helber Belmiro <helber.belmiro@gmail.com>
@TheJavaGuy
Copy link

@ricardozanini @hbelmiro If this is still needed maybe I can take a look.

@hbelmiro
Copy link
Contributor

Yes. It's still needed, but I don't know if you have enough privileges.
@ricardozanini Do you know if he needs to be in the Quarkiverse organization to work on this?

@ricardozanini
Copy link
Member Author

@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. :)

@github-actions
Copy link
Contributor

github-actions bot commented Aug 1, 2023

@ricardozanini @hbelmiro This is being labeled as Stale.

@github-actions github-actions bot added the Stale label Aug 1, 2023
@hbelmiro hbelmiro added the pinned Issues and PRs that must not stale label Aug 1, 2023
@TheJavaGuy
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
added to backlog The issue was added to backlog area:documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed pinned Issues and PRs that must not stale
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants