konflux-ci · brunoapimentel · Mar 14, 2025 · Mar 14, 2025 · Mar 14, 2025
@@ -74,11 +74,11 @@ Alternatively, in the git repo for the component that nudges, push a commit. Whe
 
 Prerequisites:
 
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 
 .Procedure
 
-. In your CLI, xref:/getting-started/cli.adoc[login] to {ProductName}.
+. In your CLI, xref:/getting-started/index.adoc#getting-started-with-the-cli[login] to {ProductName}.
 . List your components, and identify the names of the components you want to relate to each other.
 +
 `kubectl get components`

@@ -116,7 +116,7 @@ When building content from GitHub, you will need to install an application for P
 
 .Prerequisites
 
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 
 .Procedure
 

@@ -50,7 +50,7 @@ NOTE: GitHub and GitLab are supported source control providers. GitLab support r
 
 * xref:/installing/enabling-builds.adoc[Enabled] build pipelines for your instance of {ProductName}.
 * link:https://kubernetes.io/docs/tasks/tools/[kubectl] CLI tool
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 
 .*Procedures*
 
@@ -118,7 +118,7 @@ After the build PipelineRuns are completed from git push events, the Components
 
 .Prerequisites
 
-* xref:/getting-started/cli.adoc[Login] to {ProductName}.
+* xref:/getting-started/index.adoc#getting-started-with-the-cli[Login] to {ProductName}.
 
 * Install the link:https://stedolan.github.io/jq/download/[jq] CLI tool.
 

@@ -30,7 +30,7 @@ NOTE: You can also delete an application by selecting *Actions > Delete Applicat
 
 * You have successfully signed into {ProductName}.
 * You have the workspace admin role.
-* You must have xref:getting-started/cli.adoc[enabled CLI access for {ProductName}].
+* You must have xref:/getting-started/index.adoc#getting-started-with-the-cli[enabled CLI access for {ProductName}].
 
 .*Procedures*
 

@@ -9,7 +9,7 @@ After you have created a component {ProductName}, you may find yourself in a sit
 .*Prerequisites*
 
 * You have an existing Development workspace.
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 
 == Reset the build pipeline
 

@@ -68,7 +68,7 @@ The pipeline run should resume in the *Activity* > *Pipeline runs* tab.
 
 - You have already merged a pull request, but the subsequent build failed, prompting a need for retriggering.
 - You didn't rename push pipeline run name, and it is in format `component_name + '-on-push'`
-- You have CLI access to {ProductName}. For information on obtaining CLI access, refer to  xref:/getting-started/cli.adoc[Getting started in CLI]
+- You have CLI access to {ProductName}. For information on obtaining CLI access, refer to  xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in CLI]
 
 .**Procedure**
 

@@ -1,4 +1,2 @@
 * xref:index.adoc[Why {ProductName}?]
-* Getting started
-** xref:getting-started/index.adoc[Getting started with {ProductName}]
-** xref:getting-started/cli.adoc[Getting started with the CLI]
+* xref:getting-started/index.adoc[Getting started]
@@ -24,6 +24,6 @@ To access {ProductName}, your PE needs to give you the URL to your team's instan
 . *Test:* bring components together and test them as a whole application.
 . *Release:* transfer ownership of your application to somewhere outside of {ProductName}, like a container registry.
 
+== Getting started with the CLI
 
-
-
+include::ROOT:partial$getting-started/{context}-getting-started-with-the-cli.adoc[]
@@ -18,7 +18,7 @@ Don't take our word on the transparency -- you can download and inspect these ar
 
 * Install the link:https://stedolan.github.io/jq/download/[jq] CLI tool.
 
-* xref:/getting-started/cli.adoc[Login] to {ProductName}.
+* xref:/getting-started/index.adoc#getting-started-with-the-cli[Login] to {ProductName}.
 
 .Procedure
 

@@ -35,7 +35,7 @@ The SBOM is unsigned so there is no way to verify whether it has been tampered w
 
 * Install the link:https://stedolan.github.io/jq/download/[jq] CLI tool.
 
-* xref:/getting-started/cli.adoc[Login] to {ProductName}.
+* xref:/getting-started/index.adoc#getting-started-with-the-cli[Login] to {ProductName}.
 
 * You have found the image for a xref:/building/creating.adoc#finding-the-built-image[recently completed build pipeline] and exported the value to the `IMAGE` environment variable.
 

@@ -15,7 +15,7 @@ Cloning an application involves replicating the application's code and configura
 
 * You have the link:https://github.com/konflux-ci/architecture/blob/main/ADR/0011-roles-and-permissions.md[Maintainer role] or greater in the original workspace where the embargoed issue was identified.
 // Maintainer role was xref:getting-started/roles_permissions/ Currently no such file in konflux-ci/docs. Add a link if the doc is published.
-* You have xref:/getting-started/cli.adoc[enabled CLI access for {ProductName}].
+* You have xref:/getting-started/index.adoc#getting-started-with-the-cli[enabled CLI access for {ProductName}].
 
 .**Procedure**
 
@@ -34,7 +34,7 @@ NOTE: Creating a private fork of the public link:https://docs.github.com/en/repo
 * You can reuse a personal workspace, but limit the link:https://console.redhat.com/preview/application-pipeline/access[User Access] to a minimal number of required collaborators.
 ====
 
-. Log in to the original workspace where the application was previously being developed using the `kubectl` CLI tool. (See xref:/getting-started/cli.adoc[Getting started with CLI].) Append `/workspaces/<original-tenant-workspace>` to the {ProductName} API URL used in the `kubectl login` command to target a particular workspace other than your default user workspace.
+. Log in to the original workspace where the application was previously being developed using the `kubectl` CLI tool. (See xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started with CLI].) Append `/workspaces/<original-tenant-workspace>` to the {ProductName} API URL used in the `kubectl login` command to target a particular workspace other than your default user workspace.
 // Add a link to the KUBECONFIG workflow when it's documented. Either approach is legit, up to a user to choose.
 . To export records the application from the original workspace with details changed to refer to your new private workspace, run the following command:
 

@@ -9,7 +9,7 @@ When an application is ready for release, the Development team contacts the owne
 .*Prerequisites*
 
 * An existing Development and Managed workspace.
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 * An existing `ReleasePlan` object in the Development workspace.
 
 .*Procedures*

@@ -9,7 +9,7 @@ The development team creates a `ReleasePlan` object in the developer workspace.
 .*Prerequisites*
 
 * You have an existing Development workspace.
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 
 .*Procedures*
 

@@ -9,7 +9,7 @@ The development team creates a `Release` object in the developer workspace. The
 .*Prerequisites*
 
 * You have an existing Development workspace.
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 * You have completed the steps for creating a ReleasePlanAdmission and a matching ReleasePlan.
 
 .*Procedures*

@@ -9,7 +9,7 @@ The gist here is that you are going to follow the regular instructions to xref:/
 .*Prerequisites*
 
 * You have an existing Development workspace.
-* You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+* You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 * Either choose one of the link:https://github.com/konflux-ci/release-service-catalog[konflux release pipelines], or write your own.
 
 NOTE: If you write a good reusable release pipeline, please submit it to our link:https://github.com/konflux-ci/release-service-catalog[catalog] so others can use it.

@@ -23,7 +23,7 @@ integration tests manually in xref:/testing/integration/rerunning.adoc[Rerunning
 NOTE: When multiple contexts are defined, the IntegrationTestScenario will execute if any of the specified contexts match the snapshot. This approach ensures that the test runs if at least one context applies, without requiring all defined contexts to be met.
 
 .Prerequisites
-- You have CLI access to the specific OpenShift cluster. For information on obtaining CLI access, refer xref:ROOT:getting-started/cli.adoc[Getting started with the CLI].
+- You have CLI access to the specific OpenShift cluster. For information on obtaining CLI access, refer xref:ROOT:/getting-started/index.adoc#getting-started-with-the-cli[Getting started with the CLI].
 
 .Procedure
 

@@ -44,7 +44,7 @@ There are three timeouts that need to be defined:
 NOTE: Since the integration service already sets default timeouts to integration pipelineRuns, it is necessary to set all of the above timeouts to prevent errors.
 
 You can define the above timeouts by setting the annotations on the IntegrationTestScenario in the following
-way through the CLI (consult the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page):
+way through the CLI (consult the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page):
 
 [source,bash]
 ----

@@ -26,7 +26,7 @@ $ kubectl label snapshot [snapshot name] test.appstudio.openshift.io/run=[scenar
 
 - You have a snapshot that has completed all its initial tests. All initial tests must be finished before you trigger subsequent tests.
 - The snapshot for which tests will be retriggered has completed its initial tests.
-- You have CLI access to the specific OpenShift cluster. For information on obtaining CLI access, refer xref:/getting-started/cli.adoc[Getting started with the CLI].
+- You have CLI access to the specific OpenShift cluster. For information on obtaining CLI access, refer xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started with the CLI].
 
 == Procedure
 

@@ -3,7 +3,7 @@
 In {ProductName}, the integration service provides users with the ability to reset their component's Global Candidate List to a desired state with a manually created `override` snapshot which can then be a candidate for further promotion (release) if it passes all integration tests.
 
 == Prerequisites
-- You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+- You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 - You have an existing managed workspace such as `ws-sample`, an application such as `application-sample` and a component such as `component-sample`.
 
 == Procedures

@@ -35,7 +35,7 @@ spec:
 Aside from the Snapshots which are created and processed automatically by the {ProductName} services, it is also possible to create manual Snapshots which can then be tested and released if they conform to the users requirements.
 
 == Prerequisites
-- You have completed the steps listed in the xref:/getting-started/cli.adoc[Getting started in the CLI] page.
+- You have completed the steps listed in the xref:/getting-started/index.adoc#getting-started-with-the-cli[Getting started in the CLI] page.
 - You have an existing managed workspace such as `ws-sample`, an application such as `application-sample` and a component such as `component-sample`.
 
 == Procedures

@@ -0,0 +1 @@
+In order to use the CLI to interact with Konflux, contact your Platform Engineer.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		In order to use the CLI to interact with Konflux, contact your Platform Engineer.