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

wants to merge 1 commit into from

Conversation

jseseCCS
Copy link
Contributor

HACDOCS-540

  • changed "task" to "Tekton task."
  • changed "workspace" definition.

@jseseCCS jseseCCS added documentation Improvements or additions to documentation WIP work in progress labels Sep 25, 2023
@jseseCCS jseseCCS self-assigned this Sep 25, 2023
@github-actions github-actions bot added the size: S Small label Sep 25, 2023
@github-actions
Copy link

🚀 Preview is available at https://pr-196--boisterous-meerkat-894982.netlify.app

arewm
arewm reviewed Oct 3, 2023
View reviewed changes
docs/modules/ROOT/pages/glossary/index.adoc
@@ -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** +
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.

docs/modules/ROOT/pages/glossary/index.adoc
**workspace** +
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.

docs/modules/ROOT/pages/glossary/index.adoc
@@ -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?

@mattreid
Copy link

mattreid commented Oct 4, 2023

@jseseCCS Would you want to track other glossary updates through a different ticket?
Not sure the right level of depth for a glossary, but for commit:
A change to one or more files. In App Studio, commits that you make to a linked Git repository move through the pipeline and automatically get published.
That's only true if they're using custom pipelines for that component, and have our app installed. A default build pipeline won't react to a commit change, users manually trigger builds for those. Publish could be ambiguous here too. To automatically release a commit, its corresponding component must use a custom pipeline and grant access to our GH app so that the commit triggers a build, the build must complete, pass any integration tests defined, be merged, trigger a new round of build and test, and then if their app is configured for release (and to automatically release), then a release would be triggered.

Do we mean released when we say published there? or is the intent different?

@arewm
Copy link
Contributor

arewm commented Jul 17, 2024

The redhat-appstudio docs are deprecated. Would you be able to recreate a similar PR on konflux-ci/docs?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@arewm arewm arewm left review comments

@mattreid mattreid Awaiting requested review from mattreid

@scoheb scoheb Awaiting requested review from scoheb

At least 1 approving review is required to merge this pull request.

Assignees

@jseseCCS jseseCCS

Labels
documentation Improvements or additions to documentation size: S Small WIP work in progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jseseCCS @mattreid @arewm