WIP PR for SRVLOGIC-128: [DOC] Modularize the "Getting Started" (top-level) section. #335
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kaldesai
requested review from
radtriste,
MarianMacik,
ricardozanini and
krisv
as code owners
✅ Deploy Preview for tangerine-crostata-04a6bf ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
kaldesai
added
DO_NOT_MERGE 🙅
|
@radtriste, @ricardozanini, @MarianMacik, and @krisv can you please take a look? Thank you! |
1 similar comment
|
@radtriste, @ricardozanini, @MarianMacik, and @krisv can you please take a look? Thank you! |
radtriste
reviewed
May 10, 2023
Comment on lines
+12
to
+16
| * <<proc-boostrapping-a-project,Bootstrapping a project>> | ||
| * <<proc-creating-a-workflow,Creating a workflow>> | ||
| * <<proc-building-your-workflow-application,Building your workflow application>> | ||
| * <<proc-running-your-workflow-application,Running your workflow application>> | ||
| * <<proc-testing-your-workflow-application,Testing your workflow application>> |
| * `Inject Mantra`: Injects a `Mantra` message into the response | ||
|
|
||
| .Example Hello World workflow | ||
| image::getting-started/hello-world-workflow.png[] |
| * Visual Studio Code with https://marketplace.visualstudio.com/items?itemName=redhat.java[Red Hat Java Extension] | ||
| and https://marketplace.visualstudio.com/items?itemName=redhat.vscode-extension-serverless-workflow-editor[Red Hat Serverless Workflow Editor] is installed to edit your workflows. | ||
|
|
||
| For more information about the tooling and the required dependencies, see xref:getting-started/getting-familiar-with-our-tooling.adoc[Getting familiar with {product_name} tooling]. |
|
|
||
| [NOTE] | ||
| ==== | ||
| The workflow definition follows the CNCF Serverless Workflow specification. For more information, see |
| // links | ||
| :quarkus_config_guide_url: https://quarkus.io/guides/config-reference | ||
|
|
||
| [id="assembly-cncf-serverless-workflow-specification-support_{context}"] |
There was a problem hiding this comment.
{context} does not exist anymore
| :navtitle: Running your workflow application | ||
| // :page-aliases: | ||
|
|
||
| [id="proc-running-your-workflow-application_{context}"] |
There was a problem hiding this comment.
context does not exist anymore
| ---- | ||
| quarkus dev | ||
| ---- | ||
| For more information about Knative workflow CLI, see xref:tooling/kn-plugin-workflow-overview.adoc[{context} plug-in for Knative CLI]. |
There was a problem hiding this comment.
use {product_name} instead of {context}
| quarkus dev | ||
| ---- | ||
| For more information about Knative workflow CLI, see xref:tooling/kn-plugin-workflow-overview.adoc[{context} plug-in for Knative CLI]. | ||
| Also, to deploy and run your workflow application, see xref:cloud/deploying-on-minikube.adoc[Deploying workflow application on Minikube] |
|
|
||
| == Additional resources | ||
|
|
||
| * xref:getting-started/getting-familiar-with-our-tooling.adoc[Getting familiar with {product_name} tooling] |
| @@ -0,0 +1,4 @@ | |||
| .Getting Started | |||
| ** xref:getting-started/getting-started-modules/assembly-create-your-first-workflow-service.adoc[Creating your first workflow service] | |||
| ** xref:getting-started/getting-started-modules/assembly-cncf-serverless-workflow-specification-support[CNCF Serverless Workflow specification] | |||
MarianMacik
reviewed
May 17, 2023
serverlessworkflow/modules/ROOT/pages/_common-content/getting-started-requirement.adoc
Outdated
Show resolved
Hide resolved
...ges/getting-started/getting-started-modules/assembly-create-your-first-workflow-service.adoc
Outdated
Show resolved
Hide resolved
|
@MarianMacik @radtriste I have incorporated your feedback. Can you please verify? |
|
@ricardozanini and @krisv, Can you please review this? Thank you! |
MarianMacik
reviewed
May 30, 2023
| @@ -1,18 +1,27 @@ | |||
| = Getting familiar with {product_name} tooling | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
@kaldesai seems fine overall, but please do not keep the links/references commented. If they are not used anymore because you moved to another page/module, just remove them instead. Thank you very much!
EDIT: also there are a few comments from @radtriste and @MarianMacik to be handled.
| //* Getting Started | ||
| //** xref:getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service] | ||
| //** xref:getting-started/cncf-serverless-workflow-specification-support.adoc[CNCF Serverless Workflow specification] | ||
| //** xref:getting-started/getting-familiar-with-our-tooling.adoc[Getting familiar with tooling] |
There was a problem hiding this comment.
Why are we commenting these sections?
|
|
||
| include::../../pages/_common-content/report-issue.adoc[] | ||
| //include::../../pages/_common-content/report-issue.adoc[] |
There was a problem hiding this comment.
Why removing these includes?
|
Closing as stale, please reopen if still relevant. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Incorporating the following mod doc JIRAs in the PR: