From 3ff75afb860f795640b84d4235e8cefc8f2b098f Mon Sep 17 00:00:00 2001 From: Chr1st1anSears <117944059+Chr1st1anSears@users.noreply.github.com> Date: Wed, 8 May 2024 14:59:09 -0400 Subject: [PATCH] Update index.adoc Put in comments for xrefs we'll need to add in the future. That way we can grep for them throughout the repo and add in the xrefs before Devconf. --- docs/modules/ROOT/pages/getting-started/index.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/getting-started/index.adoc b/docs/modules/ROOT/pages/getting-started/index.adoc index 2bfcded2..63262194 100644 --- a/docs/modules/ROOT/pages/getting-started/index.adoc +++ b/docs/modules/ROOT/pages/getting-started/index.adoc @@ -10,7 +10,7 @@ Depending on your role, read whichever following section applies best to you, to == For PEs Before anyone can use it, you need to link:https://github.com/konflux-ci/konflux-ci?tab=readme-ov-file#konflux-ci[install {ProductName}]. - +//Add xref for add users and assigning them After installing {ProductName}, you can add users and assign them to a {ProductName} workspace. We use {ProductName} workspaces for role-based access control (RBAC). == For developers @@ -19,6 +19,7 @@ The purpose of {ProductName} is to help your applications get out into the world To access {ProductName}, your PE needs to give you the URL to your team's instance and your user credentials. Once you have that access, you can use {ProductName} to do a lot of different things. But the actions you can take generally fall into 3 key categories: +//Add xrefs for each of these bullets . *Build:* as mentioned, to form an application, you build its components as images from a repository. While building, {ProductName} also runs certain checks against those images and their source repository. . *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.