RHIDP-7849 Added existing modules to _Getting started with RHDH for PE_ #1267
Conversation
titles/getting-started-with-rhdh-on-ocp-for-the-platform-engineer/master.adoc
Outdated
Show resolved
Hide resolved
titles/getting-started-with-rhdh-on-ocp-for-the-platform-engineer/master.adoc
Outdated
Show resolved
Hide resolved
...ion-prerequisites-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
Outdated
Show resolved
Hide resolved
...ion-prerequisites-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
Outdated
Show resolved
Hide resolved
...tion-secrets-step-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
Outdated
Show resolved
Hide resolved
…n-secrets-step-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
…eer/master.adoc Co-authored-by: Kim Tsao <[email protected]>
modules/configuring/proc-provisioning-your-custom-configuration.adoc
Outdated
Show resolved
Hide resolved
...ion-prerequisites-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
Show resolved
Hide resolved
…n-prerequisites-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
| * Injects environment variables provisioned in your custom secrets. | ||
|
|
||
| .Prerequisites | ||
| * By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. |
There was a problem hiding this comment.
| * By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance. | |
| * You have link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}] installed. | |
| * You have access with developer permissions to the {ocp-short} cluster that should contain your {product-short} instance. |
There was a problem hiding this comment.
This would remove an important piece of information : you have access with the CLI (not with the web console).
There was a problem hiding this comment.
I see. Is there another way to rewrite it so that the prerequisites match (in this case they should all start with "You...").
| = Preparing your external services | ||
|
|
||
| {product} relies on external services. | ||
| Prepare the required external services. |
There was a problem hiding this comment.
I wonder if the overview of required services wouldn't look and read better as a table
| .Procedure | ||
| . Author your custom `_<my_product_secrets>_.txt` file to provision your secrets as environment variables values in an {ocp-short} secret, rather than in clear text in your configuration files. | ||
| It contains one secret per line in `KEY=value` form. | ||
| . For security, store your secrets as environment variables values in an {ocp-short} secret, |
There was a problem hiding this comment.
this sentence might work better as an admonition
...on-appconfig-step-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
Outdated
Show resolved
Hide resolved
| - permission | ||
| ---- | ||
| Most fields use environment variables that you defined in secrets in the previous step. | ||
| `app`:: |
There was a problem hiding this comment.
is this a table that the preview doesn't display correctly?
There was a problem hiding this comment.
consider using a table instead. this feels difficult to read, tables are a bit easier to navigate, imho
|
|
||
| ** To prepare a deployment with the {product} Operator on {ocp-short}, you can start with an empty file. | ||
|
|
||
| ** To prepare a deployment with the {product} Helm chart, or on Kubernetes, enter the {product-short} base URL in the relevant fields in your `{my-app-config-file}` file to ensure proper functionality of {product-short}. |
There was a problem hiding this comment.
I'd label this as optional since you have to choose between the operator or helm deployment, no?
There was a problem hiding this comment.
This is unchanged content (just moved to a snippet. The 2 unordered steps denote the user choice (Operator, Helm). See: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1267/configuring/#provisioning-your-custom-configuration
| @@ -0,0 +1,9 @@ | |||
| .Next steps | |||
| Consider provisioning additional config maps and secrets: | |||
There was a problem hiding this comment.
what are the benefits? instead of telling the user to consider this step, I'd explain why they should do it
There was a problem hiding this comment.
This is unchanged content (just moved to a snippet.
| @@ -1,10 +1,53 @@ | |||
| include::artifacts/attributes.adoc[] | |||
| :title: Getting started with {product} on {ocp-brand-name} for the platform engineer | |||
| :subtitle: As a platform engineer, prepare your IT infrastructure including {ocp-brand-name} and required external components, and run your first {product} ({product-very-short}) instance in production. | |||
| :abstract: As a platform engineer, prepare your IT infrastructure including {ocp-brand-name} and required external components, and run your first {product} ({product-very-short}) instance in production. | |||
| :context: customizing-display | |||
| :abstract: As a platform engineer, prepare your IT infrastructure including {ocp-brand-name} and required external components, and run your first {product} ({product-very-short}) instance in production with an adapted secure, efficient, and resilient configuration. | |||
There was a problem hiding this comment.
do you have to specify this is a platform engineer procedure? it feels a bit clunky
There was a problem hiding this comment.
This is currently under debate in the docs team. I am waiting for the debate conclusion to update it.
| [id="{context}"] | ||
| = {title} | ||
|
|
||
| {abstract} | ||
|
|
||
| Adapted:: |
There was a problem hiding this comment.
I'm not sure if it is because of the titles (adapted, secure etc.) but this section feels confusing.
titles/getting-started-with-rhdh-on-ocp-for-the-platform-engineer/master.adoc
Outdated
Show resolved
Hide resolved
…n-appconfig-step-in-getting-started-with-rhdh-on-ocp-for-the-platform-engineer-context.adoc
titles/getting-started-with-rhdh-on-ocp-for-the-platform-engineer/master.adoc
Show resolved
Hide resolved
This is a rough outline draft to see how we can leverage existing content to populate the book.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 1.7
Issue: https://issues.redhat.com/browse/RHIDP-7849
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1267/getting-started-with-rhdh-on-ocp-for-the-platform-engineer/