Skip to content

Address SME feedback across all documentation pages#134

Merged
Roming22 merged 2 commits intoredhat-appstudio:mainfrom
gtrivedi88:docs/fix-quay-link
Apr 9, 2026
Merged

Address SME feedback across all documentation pages#134
Roming22 merged 2 commits intoredhat-appstudio:mainfrom
gtrivedi88:docs/fix-quay-link

Conversation

@gtrivedi88
Copy link
Copy Markdown
Contributor

@gtrivedi88 gtrivedi88 commented Apr 9, 2026

Summary

Addresses all SME feedback items:

Preparing to install:

  • Fix bad link for "Create an organization" (→ docs.quay.io/glossary/organizations.html)
  • Fix bad link for "Create an OAuth application" (→ docs.quay.io/glossary/access-token.html)
  • Add GitLab env vars (GITLAB__HOST, GITLAB__GROUP, GITLAB__TOKEN) to tsf.env example and variable table

Installing:

  • Replace {TSFInstallerImage} attribute with actual image path quay.io/redhat-ads/tsf-cli:unstable
  • Use $GITLAB__TOKEN and $GITLAB__HOST env vars from tsf.env in GitLab config commands
  • Add note that default-tenant is the default namespace, with link to Konflux docs, and note about multiple namespaces
  • Move config.yaml / tsf-config ConfigMap blurb from Verifying page to Installing page (Configure the cluster section)

Getting started:

  • Fix PR description: "build pipeline definition" → "Tekton pipeline definitions that trigger on pull request and push events... Those pipelines control the lifecycle of changes submitted to the repository."
  • Add oc get integrationtestscenarios command to view integration test CR
  • Fix CI checks description: clarify that checks are created for both GH and GL; the difference is GH App (created ahead of time) vs GL webhook (created when repo is onboarded)

Verifying and accessing:

  • Remove config.yaml blurb (moved to Installing)

Troubleshooting:

  • Add table of contents with anchor links to each issue section

Test plan

  • Verify all links resolve correctly on the published site
  • Verify TOC links navigate to correct sections on troubleshooting page

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88 gtrivedi88 changed the title Update Quay organization docs link Address SME feedback across all documentation pages Apr 9, 2026
- Fix bad Quay OAuth application link (preparing-to-install)
- Add GitLab env vars (GITLAB__HOST, GITLAB__GROUP, GITLAB__TOKEN) to tsf.env
- Replace {TSFInstallerImage} attribute with actual image path (installing)
- Use env vars from tsf.env in GitLab config commands (installing)
- Add default-tenant namespace note and Konflux docs link (installing)
- Move config.yaml blurb from Verifying to Installing page
- Fix PR description: "build pipeline definition" → "Tekton pipeline definitions"
- Add oc get integrationtestscenarios command (getting-started)
- Fix CI checks: clarify GH App vs GL webhook integration differences
- Add table of contents with section anchors (troubleshooting)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88 gtrivedi88 force-pushed the docs/fix-quay-link branch from ffd4c7d to a0ac6d5 Compare April 9, 2026 15:15
@Roming22 Roming22 merged commit e971074 into redhat-appstudio:main Apr 9, 2026
2 checks passed
----

. **Creates CI checks** on the pull request (GitHub checks or GitLab webhooks, depending on your Git provider). Two checks appear:
. **Creates CI checks** on the pull request. {KonfluxName} creates checks for both GitHub and GitLab. The difference is how the integration with {KonfluxName} is managed: for GitHub, a GitHub App is created ahead of time during installation; for GitLab, the webhook is created when the repository is onboarded. Two checks appear:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Remove that bit.
Add For GitLab the webhook is created and configured in the repository. under the After you create a component, {KonfluxName} automatically section.

oc create secret generic gitlab-auth-secret \
-n <tenant-namespace> \
--from-literal=password=<project-access-token> \
--from-literal=password="$GITLAB__TOKEN" \
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All this section is going to much simplified by RHTAP-6483.

gtrivedi88 added a commit to gtrivedi88/tsf-cli that referenced this pull request Apr 13, 2026
RHTAP-6483: Replace manual oc create/label/annotate secret commands
with tsf integration gitlab CLI command. The installer handles
namespace and secret creation for default-tenant during deployment.

PR redhat-appstudio#134 review: Remove GH App vs GL webhook detail from CI checks
description. Add GitLab webhook note per SME feedback.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants