Terminology style updates for odo and helm

[bergerhoffer]

No description provided.

[bergerhoffer]

@boczkowska @Preeticp I made the updates to the helm and odo CLI docs for our new style guidelines. I also fixed anything else I saw while I was reviewing.

Can you please review these updates to make sure that these changes are okay? Thanks!

[openshift-docs-preview-bot]

The preview will be available shortly at:

• https://term-updates-cli-odo--ocpdocs.netlify.com/

[bergerhoffer]

@Preeticp I also tried to start going through the pipelines tkn docs, but there are a lot of pipeline terms that I'm not sure what should be done for them: Pipeline/PipelineRun/Task/TaskRun/Condition/Pipeline Resources/Resource/ClusterTask/EventListener

Can these terms follow our general term guidance, for example "task run"/"cluster task", etc.? Or at the very least, I assume that they are objects and should be styled as TaskRun and ClusterTask? Can you take a look through and update the tkn docs when you do the Pipelines section?

[yhontyk]

One question, otherwise LGTM.

[yhontyk]

Is there a reason to change the CLI prompt here? There is no need to run this command with admin rights.

[bergerhoffer]

@boczkowska I did this because the earlier steps in this procedure are all run using the "#" prompt, and there weren't any steps to switch back to a normal user or anything before running this command.

Are you okay with this change, or would you like me to revert these ones?

[yhontyk]

It doesn't really matter if this particular command is run with admin rights or not, so I'd leave $

Hmm, I don't think we need to explicitly specify how to run commands as a superuser (sudo, su etc), it's developer-facing documentation in the end, but I can add instructions obviously.

[bergerhoffer]

Okay, I'll go ahead and revert it then, thanks.

[yhontyk]

See my comment above.

[Preeticp]

@bergerhoffer apologies for the delay.
Looks good to me except for the question raised by Yana, on the change from $ to #

[Preeticp]

@bergerhoffer I will fix the changes for Pipelines CLI too. We have a Jira issue to track the effort and will plan it into our sprints. Meanwhile, I am updating them as I work on some of the Pipelines PR but this content is currently in the core Pipelines bucket.

[bergerhoffer]

/cherrypick enterprise-4.7

[bergerhoffer]

/cherrypick enterprise-4.6

[bergerhoffer]

/cherrypick enterprise-4.5

[openshift-cherrypick-robot]

@bergerhoffer: new pull request created: #27868

Details

In response to this:

/cherrypick enterprise-4.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[bergerhoffer]

/cherrypick enterprise-4.4

[openshift-cherrypick-robot]

@bergerhoffer: #27428 failed to apply on top of branch "enterprise-4.5":

Applying: Terminology style updates for odo and helm
Using index info to reconstruct a base tree...
M	cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
M	cli_reference/developer_cli_odo/odo-release-notes.adoc
M	modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
M	modules/developer-cli-odo-connecting-the-database.adoc
M	modules/developer-cli-odo-deploying-the-back-end-component.adoc
M	modules/developer-cli-odo-installing-odo-on-windows.adoc
A	modules/helm-adding-helm-chart-repositories.adoc
A	modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc deleted in HEAD and modified in Terminology style updates for odo and helm. Version Terminology style updates for odo and helm of modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc left in tree.
CONFLICT (modify/delete): modules/helm-adding-helm-chart-repositories.adoc deleted in HEAD and modified in Terminology style updates for odo and helm. Version Terminology style updates for odo and helm of modules/helm-adding-helm-chart-repositories.adoc left in tree.
Auto-merging modules/developer-cli-odo-installing-odo-on-windows.adoc
Auto-merging modules/developer-cli-odo-deploying-the-back-end-component.adoc
Auto-merging modules/developer-cli-odo-connecting-the-database.adoc
Auto-merging modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
Auto-merging cli_reference/developer_cli_odo/odo-release-notes.adoc
CONFLICT (content): Merge conflict in cli_reference/developer_cli_odo/odo-release-notes.adoc
Auto-merging cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
CONFLICT (content): Merge conflict in cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Terminology style updates for odo and helm
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherrypick enterprise-4.5

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[openshift-cherrypick-robot]

@bergerhoffer: new pull request created: #27869

Details

In response to this:

/cherrypick enterprise-4.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[openshift-cherrypick-robot]

@bergerhoffer: #27428 failed to apply on top of branch "enterprise-4.4":

Applying: Terminology style updates for odo and helm
Using index info to reconstruct a base tree...
M	cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
M	cli_reference/developer_cli_odo/odo-release-notes.adoc
M	modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
M	modules/developer-cli-odo-connecting-the-database.adoc
M	modules/developer-cli-odo-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc
A	modules/developer-cli-odo-converting-an-s2i-component-into-a-devfile-component.adoc
M	modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc
M	modules/developer-cli-odo-creating-services-from-yaml-files.adoc
M	modules/developer-cli-odo-deploying-the-back-end-component.adoc
M	modules/developer-cli-odo-exposing-the-components-to-the-public.adoc
M	modules/developer-cli-odo-installing-odo-on-windows.adoc
M	modules/developer-cli-odo-linking-both-components.adoc
M	modules/developer-cli-odo-using-command-completion.adoc
A	modules/helm-adding-helm-chart-repositories.adoc
A	modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc
M	modules/helm-installing-helm.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/helm-installing-helm.adoc
CONFLICT (modify/delete): modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc deleted in HEAD and modified in Terminology style updates for odo and helm. Version Terminology style updates for odo and helm of modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc left in tree.
CONFLICT (modify/delete): modules/helm-adding-helm-chart-repositories.adoc deleted in HEAD and modified in Terminology style updates for odo and helm. Version Terminology style updates for odo and helm of modules/helm-adding-helm-chart-repositories.adoc left in tree.
Auto-merging modules/developer-cli-odo-using-command-completion.adoc
Auto-merging modules/developer-cli-odo-linking-both-components.adoc
CONFLICT (content): Merge conflict in modules/developer-cli-odo-linking-both-components.adoc
Auto-merging modules/developer-cli-odo-installing-odo-on-windows.adoc
Auto-merging modules/developer-cli-odo-exposing-the-components-to-the-public.adoc
Auto-merging modules/developer-cli-odo-deploying-the-back-end-component.adoc
Auto-merging modules/developer-cli-odo-creating-services-from-yaml-files.adoc
Auto-merging modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc
CONFLICT (content): Merge conflict in modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc
CONFLICT (modify/delete): modules/developer-cli-odo-converting-an-s2i-component-into-a-devfile-component.adoc deleted in HEAD and modified in Terminology style updates for odo and helm. Version Terminology style updates for odo and helm of modules/developer-cli-odo-converting-an-s2i-component-into-a-devfile-component.adoc left in tree.
Auto-merging modules/developer-cli-odo-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc
CONFLICT (content): Merge conflict in modules/developer-cli-odo-connecting-your-application-to-multiple-services-using-openshift-service-catalog.adoc
Auto-merging modules/developer-cli-odo-connecting-the-database.adoc
CONFLICT (content): Merge conflict in modules/developer-cli-odo-connecting-the-database.adoc
Auto-merging modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
CONFLICT (content): Merge conflict in modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
Auto-merging cli_reference/developer_cli_odo/odo-release-notes.adoc
CONFLICT (content): Merge conflict in cli_reference/developer_cli_odo/odo-release-notes.adoc
Auto-merging cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
CONFLICT (content): Merge conflict in cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Terminology style updates for odo and helm
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

In response to this:

/cherrypick enterprise-4.4

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.