Skip to content

Commit ae40ee5

Browse files
authored
Merge pull request #32388 from Preeticp/crd_format
crd formatting for release notes and all assembly stubs
2 parents 54e57ef + 81a355f commit ae40ee5

10 files changed

+125
-134
lines changed

cicd/pipelines/creating-applications-with-cicd-pipelines.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This section uses the `pipelines-tutorial` example to demonstrate the preceding
2929
* You have access to an {product-title} cluster.
3030
* You have installed xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines] using the {pipelines-title} Operator listed in the OpenShift OperatorHub. Once installed, it is applicable to the entire cluster.
3131
* You have installed xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines CLI].
32-
* You have forked the front-end link:https://github.com/openshift/pipelines-vote-ui/tree/{pipelines-ver}[`pipelines-vote-ui`] and back-end link:https://github.com/openshift/pipelines-vote-api/tree/{pipelines-ver}[`pipelines-vote-api`] Git repositories using your GitHub ID, and have Administrator access to these repositories.
32+
* You have forked the front-end link:https://github.com/openshift/pipelines-vote-ui/tree/{pipelines-ver}[`pipelines-vote-ui`] and back-end link:https://github.com/openshift/pipelines-vote-api/tree/{pipelines-ver}[`pipelines-vote-api`] Git repositories using your GitHub ID, and have administrator access to these repositories.
3333
* Optional: You have cloned the link:https://github.com/openshift/pipelines-tutorial/tree/{pipelines-ver}[`pipelines-tutorial`] Git repository.
3434

3535

@@ -60,7 +60,7 @@ include::modules/op-triggering-a-pipelinerun.adoc[leveloffset=+1]
6060
[id="pipeline-addtl-resources"]
6161
== Additional resources
6262

63-
* For more details on pipelines in the *Developer* perspective, see the xref:../../cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc#working-with-pipelines-using-the-developer-perspective[working with Pipelines in the *Developer* perspective] section.
63+
* For more details on pipelines in the *Developer* perspective, see the xref:../../cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc#working-with-pipelines-using-the-developer-perspective[working with pipelines in the *Developer* perspective] section.
6464
* To learn more about Security Context Constraints (SCCs), see the xref:../../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing Security Context Constraints] section.
6565
* For more examples of reusable tasks, see the link:https://github.com/openshift/pipelines-catalog[OpenShift Catalog] repository. Additionally, you can also see the Tekton Catalog in the Tekton project.
6666
* For more details on re-encrypt TLS termination, see link:https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#re-encryption-termination[Re-encryption Termination].

cicd/pipelines/installing-pipelines.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ If you have the pull secret, add the `redhat-operators` catalog to the OperatorH
2424
endif::[]
2525

2626

27-
//Installing Pipelines Operator using web console
27+
//Installing pipelines Operator using web console
2828

2929
include::modules/op-installing-pipelines-operator-in-web-console.adoc[leveloffset=+1]
3030

31-
// Installing Pipelines Operator using CLI
31+
// Installing pipelines Operator using CLI
3232

3333
include::modules/op-installing-pipelines-operator-using-the-cli.adoc[leveloffset=+1]
3434

cicd/pipelines/op-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ toc::[]
1414
* Extensibility to build images using any Kubernetes tool, such as S2I, Buildah, JIB, and Kaniko.
1515
* Portability across any Kubernetes distribution.
1616
* Powerful CLI for interacting with pipelines.
17-
* Integrated user experience with the Developer perspective of the {product-title} web console.
17+
* Integrated user experience with the *Developer* perspective of the {product-title} web console.
1818
1919
For an overview of {pipelines-title}, see xref:../../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[Understanding OpenShift Pipelines].
2020

cicd/pipelines/understanding-openshift-pipelines.adoc

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,38 @@ toc::[]
88

99
:FeatureName: OpenShift Pipelines
1010

11-
{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses Tekton building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard Custom Resource Definitions (CRDs) for defining CI/CD pipelines that are portable across Kubernetes distributions.
11+
{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses Tekton building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard custom resource definitions (CRDs) for defining CI/CD pipelines that are portable across Kubernetes distributions.
1212

13-
////
14-
{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses link:https://tekton.dev[Tekton] building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard Custom Resource Definitions (CRDs) for defining CI/CD pipelines that are portable across Kubernetes distributions.
15-
////
1613
[id="op-key-features"]
1714
== Key features
1815

19-
* {pipelines-title} is a serverless CI/CD system that runs Pipelines with all the required dependencies in isolated containers.
16+
* {pipelines-title} is a serverless CI/CD system that runs pipelines with all the required dependencies in isolated containers.
2017
* {pipelines-title} are designed for decentralized teams that work on microservice-based architecture.
2118
* {pipelines-title} use standard CI/CD pipeline definitions that are easy to extend and integrate with the existing Kubernetes tools, enabling you to scale on-demand.
2219
* You can use {pipelines-title} to build images with Kubernetes tools such as Source-to-Image (S2I), Buildah, Buildpacks, and Kaniko that are portable across any Kubernetes platform.
23-
* You can use the {product-title} Developer Console to create Tekton resources, view logs of Pipeline runs, and manage pipelines in your {product-title} namespaces.
20+
* You can use the {product-title} Developer console to create Tekton resources, view logs of pipeline runs, and manage pipelines in your {product-title} namespaces.
2421

2522
[id="op-detailed-concepts"]
2623
== OpenShift Pipeline Concepts
27-
This guide provides a detailed view of the various Pipeline concepts.
24+
This guide provides a detailed view of the various pipeline concepts.
2825

29-
//About Tasks
26+
//About tasks
3027
include::modules/op-about-tasks.adoc[leveloffset=+2]
31-
//About TaskRun
28+
//About task run
3229
include::modules/op-about-taskrun.adoc[leveloffset=+2]
33-
//About Pipelines
30+
//About pipelines
3431
include::modules/op-about-pipelines.adoc[leveloffset=+2]
35-
//About PipelineRun
32+
//About pipeline run
3633
include::modules/op-about-pipelinerun.adoc[leveloffset=+2]
37-
//About Workspace
34+
//About workspace
3835
include::modules/op-about-workspace.adoc[leveloffset=+2]
39-
//About Triggers
36+
//About triggers
4037
include::modules/op-about-triggers.adoc[leveloffset=+2]
4138

4239

4340
== Additional resources
4441

45-
* For information on installing Pipelines, see xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[Installing OpenShift Pipelines].
42+
* For information on installing pipelines, see xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[Installing OpenShift Pipelines].
4643
* For more details on creating custom CI/CD solutions, see xref:../../cicd/pipelines/creating-applications-with-cicd-pipelines.adoc#creating-applications-with-cicd-pipelines[Creating applications with CI/CD Pipelines].
4744
* For more details on re-encrypt TLS termination, see link:https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#re-encryption-termination[Re-encryption Termination].
4845
* For more details on secured routes, see the xref:../../networking/routes/secured-routes.adoc#secured-routes[Secured routes] section.

cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ include::modules/pipelines-document-attributes.adoc[]
88

99
toc::[]
1010

11-
You can use the *Developer* perspective of the {product-title} web console to create CI/CD Pipelines for your software delivery process.
11+
You can use the *Developer* perspective of the {product-title} web console to create CI/CD pipelines for your software delivery process.
1212

1313

1414
In the *Developer* perspective:
1515

16-
* Use the *Add* -> *Pipeline* -> *Pipeline Builder* option to create customized Pipelines for your application.
17-
* Use the *Add* -> *From Git* option to create Pipelines using operator-installed Pipeline templates and resources while creating an application on {product-title}.
16+
* Use the *Add* -> *Pipeline* -> *Pipeline Builder* option to create customized pipelines for your application.
17+
* Use the *Add* -> *From Git* option to create pipelines using operator-installed pipeline templates and resources while creating an application on {product-title}.
1818

19-
After you create the Pipelines for your application, you can view and visually interact with the deployed Pipelines in the *Pipelines* view. You can also use the *Topology* view to interact with the Pipelines created using the *From Git* option. You need to apply custom labels to a Pipeline created using the *Pipeline Builder* to see it in the *Topology* view.
19+
After you create the pipelines for your application, you can view and visually interact with the deployed pipelines in the *Pipelines* view. You can also use the *Topology* view to interact with the pipelines created using the *From Git* option. You need to apply custom labels to a pipeline created using the *Pipeline Builder* to see it in the *Topology* view.
2020

2121
[discrete]
2222
== Prerequisites
2323

24-
* You have access to an {product-title} cluster and have switched to the xref:../../web_console/odc-about-developer-perspective.adoc[Developer perspective] in the web console.
24+
* You have access to an {product-title} cluster and have switched to the xref:../../web_console/odc-about-developer-perspective.adoc[*Developer* perspective] in the web console.
2525
* You have the xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines Operator installed] in your cluster.
2626
* You are a cluster administrator or a user with create and edit permissions.
2727
* You have created a project.
@@ -31,7 +31,7 @@ include::modules/op-constructing-pipelines-using-pipeline-builder.adoc[leveloffs
3131

3232
== Creating applications with OpenShift Pipelines
3333

34-
To create Pipelines along with applications, use the *From Git* option in the *Add* view of the *Developer* perspective. For more information, see xref:../../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
34+
To create pipelines along with applications, use the *From Git* option in the *Add* view of the *Developer* perspective. For more information, see xref:../../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
3535

3636
include::modules/op-interacting-with-pipelines-using-the-developer-perspective.adoc[leveloffset=+1]
3737

0 commit comments

Comments
 (0)