Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

HACDOCS-540: RHTAP/App Studio glossary refinement #196

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

HACDOCS-540: RHTAP/App Studio glossary refinement #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/modules/ROOT/pages/glossary/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,6 @@ A set of compute resources that you can use to develop, test, and stage your app
**Supply-chain Levels for Software Artifacts (SLSA)** +
A link:https://slsa.dev/[security framework] that helps prevent tampering by securing the packages and infrastructure of customers’ projects.

**task** +
One or more steps that run container images. Each container image performs a piece of construction work.

**TaskRun** +
A process that executes a task on a cluster with inputs, outputs, and execution parameters. The system creates a TaskRun on its own, or as a part of a PipelineRun for each task in a pipeline.

Expand All @@ -101,5 +98,8 @@ A mechanism to secure the software supply chain by recording events in a user-de
**Tekton integration testing** +
A process that uses Tekton tasks to support the setup and execution of dynamic application tests against container images.

**Tekton task** +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to create a separate section to define all of the Tekton-relative words? If so, we could also put in items like TaskRun. These are not items that we are defining, but vocabulary that we are collecting from elsewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i was thinking the same thing. yes!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does "step" need more context, either in this definition, or its own glossary term?

One or more steps that run container images. Each container image performs a piece of construction work.

**workspace** +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you planning to add a definition for a Tekton workspace as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes. i'm keeping a list in the related Jira story (link in this PR's descr) of terms we need to define.

A storage volume that a task requires at runtime to receive input or provide output.
A technology framework that brings together all of the applications, tools, and resources teammates need to work and collaborate securely, while unifying and enhancing application delivery and access control.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to specify this to {ProductName} by something like

A technology framework in {ProductName} that [...]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, my thinking is that this will be contained in a glossary that's RHTAP-specific, so the prod name is implied. wdyt?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is a glossary strictly saying what the thing is? or should it provide context in the user's world?
Every user who signs up gets their own workspace. Users can be invited with specific permissions (see: Roles) to collaborate in other workspaces (such a product team's workspace). There are also managed workspaces, where teams can configure their application to release to.