Migrate to Quarkiverse Docs from main README

[luanbrdev]

Hey there! I'm trying to help with the issue: #213

So, I'm new here and it's my first time editing Asciidoc docs. I did a copy and paste of the information present on readme in main branch. If these implementation wasn't what is expected, let me know.

[ricardozanini]

This is amazing! Many thanks!! Can you also update the README to point people to the quarkiverse docs then? :D

[luanbrdev]

@ricardozanini I removed all documentation from README and referenced the future link in http://docs.quarkiverse.io/

[hbelmiro]

Great work @luanbrdev. Thank you!

Just one detail: Your branch is 7 commits behind the main branch. So, probably the documentation is outdated in your branch.
Comparing your branch with main, we can see that there's only one commit missing from your branch that changes README.md. Can you please add the new documentation from that commit to this branch?

Also, I have one question: you mentioned you referenced the future link in http://docs.quarkiverse.io/. I don't see it there. Did you send a PR? If so, can you link the PR here, please?

[luanbrdev]

Great work @luanbrdev. Thank you!

Just one detail: Your branch is 7 commits behind the main branch. So, probably the documentation is outdated in your branch. Comparing your branch with main, we can see that there's only one commit missing from your branch that changes README.md. Can you please add the new documentation from that commit to this branch?

Also, I have one question: you mentioned you referenced the future link in http://docs.quarkiverse.io/. I don't see it there. Did you send a PR? If so, can you link the PR here, please?

Great work @luanbrdev. Thank you!

Just one detail: Your branch is 7 commits behind the main branch. So, probably the documentation is outdated in your branch. Comparing your branch with main, we can see that there's only one commit missing from your branch that changes README.md. Can you please add the new documentation from that commit to this branch?

Also, I have one question: you mentioned you referenced the future link in http://docs.quarkiverse.io/. I don't see it there. Did you send a PR? If so, can you link the PR here, please?

@hbelmiro I'm sorry about that!
I'm not used to the fork approach and was wrong about my understanding of how 'pull' would work in my copy.

[ricardozanini]

@hbelmiro @gastaldi do you know if we can have a preview of this PR on the website? 🤔

[gastaldi]

@ricardozanini sure, here are the workflows you can use for that:

• https://github.com/quarkiverse/quarkiverse-docs/blob/main/.github/workflows/preview.yml
• https://github.com/quarkiverse/quarkiverse-docs/blob/main/.github/workflows/preview_teardown.yml

[ricardozanini]

@gastaldi it's just a matter of incorporating those workflows here? :D

[gastaldi]

Basically yes, you need a SURGE_TOKEN secret too. See https://surge.sh/help/integrating-with-circleci

[ricardozanini]

@gastaldi I can apply for a token, but I don't have permission to add secrets in this repo. Can you add it?

[gastaldi]

@ricardozanini I gave you admin access to this repo. Enjoy :)

[gastaldi]

Actually, SURGE_TOKEN is already defined as an Organization secret, so you should be all set. I created quarkiverse/quarkiverse-devops#184 to make you an admin to this repo if you still need it

[ricardozanini]

@luanbrdev can you please incorporate these workflows into this PR? If the SURGE token won't work, I can set it up here.

[gastaldi]

If I remember correctly, the SURGE_TOKEN will only work when the workflow is already in main, so I'm afraid this needs to be done in a separate PR

[gastaldi]

Also maybe this could be more PR-friendly:

• https://github.com/quarkusio/quarkusio.github.io/blob/develop/.github/workflows/build.yml#L61-L69
• https://github.com/quarkusio/quarkusio.github.io/blob/develop/.github/workflows/preview.yml
• https://github.com/quarkusio/quarkusio.github.io/blob/develop/.github/workflows/preview-teardown.yml

[ricardozanini]

If I remember correctly, the SURGE_TOKEN will only work when the workflow is already in main, so I'm afraid this needs to be done in a separate PR

@luanbrdev can you do it too? So we open a different PR just to set the previews and rebase this one to see your work live! ❤️

[ricardozanini]

@luanbrdev can you rebase?

[github-actions]

🎊 PR Preview 66d8b42 has been successfully built and deployed to https://quarkus-openapi-generator-preview-pr-493
.surge.sh

[ricardozanini]

@luanbrdev it's looking great! https://quarkus-openapi-generator-preview-pr-493.surge.sh

And it seems the GHA worked too! I'll take a look at why the comment broke the URL, thou.

[ricardozanini]

Superb job, @luanbrdev we really appreciate your effort.

[ricardozanini]

@gastaldi after merging this commit, our docs will be automatically uploaded to https://docs.quarkiverse.io/index/explore/index.html ? 👯

[gastaldi]

@ricardozanini you need to add an entry to the https://github.com/quarkiverse/quarkiverse-docs repository.

See: https://hub.quarkiverse.io/checklist/#register-the-extension-documentation-in-the-quarkiverse-docs

[ricardozanini]

@all-contributors please add @luanbrdev for docs

[allcontributors]

@ricardozanini

I've put up a pull request to add @luanbrdev! 🎉