Skip to content

Commit

Permalink
Update index.adoc
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Chr1st1anSears authored May 8, 2024
1 parent 7e77dfc commit 3ff75af
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/getting-started/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 3ff75af

Please sign in to comment.