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.

Sign up for GitHub

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

Jump to bottom

#532: Initial reorganization of Quarkus guides #536

Merged
merged 25 commits into from
Feb 27, 2024
Merged

#532: Initial reorganization of Quarkus guides #536

merged 25 commits into from
Feb 27, 2024

Conversation

domhanak
Copy link
Contributor

@domhanak domhanak commented Feb 14, 2024 •
edited
Loading

Fixes #532

Description:
Contains reorg of the quarkus guides and some extra changes to improve the docs
Tried to shorten some guides and generalize the steps we have in Quarkus guides so
they are more generic a allow user to understand the concepts first before jumping into doing
integrations, or other more complex use cases.

TODO:

  • Reorg the files in index
  • Fix links after reorg

Please make sure that your PR meets the following requirements:

  • You have read the contributions doc
  • Pull Request title is properly formatted: Issue-XYZ Subject
  • Pull Request title contains the target branch if not targeting main: [0.9.x] Issue-XYZ Subject
  • The nav.adoc file has a link to this guide in the proper category
  • The index.adoc file has a card to this guide in the proper category, with a meaningful description

ricardozanini
ricardozanini reviewed Feb 14, 2024
View reviewed changes
Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outstanding! Many thanks for the work so far!

...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc Outdated Show resolved Hide resolved
...es/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc Outdated Show resolved Hide resolved
serverlessworkflow/modules/ROOT/pages/persistence/core-concepts.adoc Outdated Show resolved Hide resolved
...advanced-developer-use-cases/getting-started/build-serverless-workflow-quarkus-examples.adoc Outdated Show resolved Hide resolved
...-cases/advanced-developer-use-cases/integrations/serverless-dashboard-with-runtime-data.adoc Outdated Show resolved Hide resolved
@ricardozanini ricardozanini mentioned this pull request Feb 14, 2024
Merged
@domhanak domhanak force-pushed the kogito-docs-532 branch 2 times, most recently from 7720891 to eb78bb1 Compare February 20, 2024 14:54
@domhanak domhanak mentioned this pull request Feb 21, 2024
Closed
@domhanak
Copy link
Contributor Author

Summary

Currently in almost good shape, there are still some TODOs in specific guides, I ll work on moving them to issues or fix them.

I would say ready for first review, hopefully we can get a preview and check before we merge.

If any other PR is merged before I ll rebase a recheck the added part for rerog.

@domhanak
Copy link
Contributor Author

List of issues reported to tackle after this:
https://github.com/apache/incubator-kie-kogito-docs/issues/created_by/domhanak

@domhanak
Copy link
Contributor Author

domhanak commented Feb 26, 2024 •
edited
Loading

@ricardozanini I completely forgot to reorganize the cards, should be last step for this.
also, running the local-build as in your #539 produces numerous errors so fixing that too :)

@domhanak domhanak marked this pull request as ready for review February 26, 2024 08:33
@domhanak domhanak requested a review from krisv as a code owner February 26, 2024 08:33
@domhanak
Copy link
Contributor Author

Pushed fixes so that the PR check will not fail when we get previews merged.

Now only to fix the new guides I introduced, meaning, link them to other, provide Header and footer

@domhanak
Copy link
Contributor Author

If you want to check locally:
npm run local-install-build
Open incubator-kie-kogito-docs/build/site/index.html in browser

ricardozanini
ricardozanini approved these changes Feb 26, 2024
View reviewed changes
Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great starting point!

serverlessworkflow/modules/ROOT/pages/_common-content/getting-started-requirement.adoc Outdated Show resolved Hide resolved
domhanak and others added 17 commits February 27, 2024 10:10
@domhanak
Fix links, move operator data-index examples to quarkus
97cbd1b
@domhanak
Remove bigger TODOs from nav and report them as issues
a3e55f1
@domhanak
Move migration-guide to separate section
387e8f1
@domhanak
Update guide to highlight the usage of examples readme
62dff2c
@domhanak
Split callback guides to quarkus section
b77ef4f
@domhanak
Use version from antora, cleanup kind for now
56e754d
@domhanak
Add placeholders for persistence, remove todo
d4c0907
@domhanak
Reorganize the cards, hide quarkus examples
085b6b3
@domhanak
Fix data_index_ref being used instead of data_index_xref
50cf69a
@domhanak
Fix migration-guide link in cloud/index.adoc
5c7dafb
@domhanak
Fix index.adoc card for advanced dev use cases
ec1e1cd
@domhanak
Fix core-concepts.adoc for integrations
8684ae4
@domhanak
Fix build, fixes links and missing variables
5a2c69d
@domhanak
Introduce better naming for advanced chapter, strip repeated text
61801dc
@domhanak
Fix typo in nav.adoc, do not override guides title
d9bbff3
@domhanak @ricardozanini
Update /getting-started-requirement.adoc to mention Java with Quarkus…
94f7eaf 
… guide

Co-authored-by: Ricardo Zanini <[email protected]>
@domhanak
Fix new getting-started guides not having resources
92acbc1
@domhanak
Copy link
Contributor Author

@ricardozanini had to rebase and force push. Did minor fixes on getting-started in quarkus side

krisv
krisv approved these changes Feb 27, 2024
View reviewed changes
Copy link
Contributor

@krisv krisv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing I found a bit counter-intuitive is that we put all the advanced topics under use cases? Maybe just get rid of use cases as the top level and just move everything inside one level down?

@domhanak
Copy link
Contributor Author

@krisv good point, the intention is to have also some advanced use-cases for non Quarkus use case and also some advanced administrator use cases, but right now we do not have them separated or done.
I can tackle this here - #553 as a follow up

@ricardozanini ricardozanini merged commit 74f95eb into apache:main Feb 27, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fjtirado fjtirado fjtirado approved these changes

@ricardozanini ricardozanini ricardozanini approved these changes

@krisv krisv krisv approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Prepare the serverless documentation for next release
4 participants
@domhanak @krisv @ricardozanini @fjtirado