Skip to content

docs: add UI onboarding guides for GitHub, GitLab, and Forgejo compon…#599

Open
MartinBasti wants to merge 1 commit intokonflux-ci:mainfrom
MartinBasti:ui-forgejo
Open

docs: add UI onboarding guides for GitHub, GitLab, and Forgejo compon…#599
MartinBasti wants to merge 1 commit intokonflux-ci:mainfrom
MartinBasti:ui-forgejo

Conversation

@MartinBasti
Copy link
Copy Markdown
Contributor

…ents

Split component onboarding docs into separate per-provider guides covering both UI and CLI, improving UX by removing the need for users to mentally skip provider-specific steps that don't apply to them. This mirrors the existing CLI section structure and makes each provider's guide self-contained and directly linkable.

  • Add UI procedures to creating-github, creating-gitlab, creating-forgejo
  • Include inline source secret creation steps for GitLab/Forgejo UI flow
  • Document Git provider annotation and Git url annotation fields
  • Simplify creating.adoc to link to per-provider guides via tables
  • Remove redundant secret requirement mentions from the main page
  • Add GitHub App installation prerequisite note for GitHub provider

@MartinBasti MartinBasti requested a review from a team as a code owner March 26, 2026 20:00
@snyk-io
Copy link
Copy Markdown

snyk-io bot commented Mar 26, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions
Copy link
Copy Markdown

🚀 Preview is available at: https://pr-599--konflux-docs.netlify.app

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request restructures the component onboarding documentation by introducing detailed UI-based procedures for GitHub, GitLab, and Forgejo. It updates the navigation labels and refactors the main 'Creating' page to link directly to these provider-specific UI and CLI guides. Review feedback focuses on correcting the spelling of 'dialogue' to 'dialog' across several files for technical consistency and suggests rephrasing a step in the GitHub guide to maintain stylistic consistency with the other onboarding documents.

Comment thread modules/building/pages/creating-forgejo.adoc Outdated
Comment thread modules/building/pages/creating-github.adoc Outdated
Comment thread modules/building/pages/creating-github.adoc Outdated
Comment thread modules/building/pages/creating-gitlab.adoc Outdated
…ents

Split component onboarding docs into separate per-provider guides covering
both UI and CLI, improving UX by removing the need for users to mentally
skip provider-specific steps that don't apply to them. This mirrors the
existing CLI section structure and makes each provider's guide
self-contained and directly linkable.

- Add UI procedures to creating-github, creating-gitlab, creating-forgejo
- Include inline source secret creation steps for GitLab/Forgejo UI flow
- Document Git provider annotation and Git url annotation fields
- Simplify creating.adoc to link to per-provider guides via tables
- Remove redundant secret requirement mentions from the main page
- Add GitHub App installation prerequisite note for GitHub provider

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

🚀 Preview is available at: https://pr-599--konflux-docs.netlify.app

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.

1 participant