Skip to content

Misc docs update#2038

Merged
pipelines-as-code[bot] merged 2 commits intotektoncd:mainfrom
chmouel:misc-docs
Apr 10, 2025
Merged

Misc docs update#2038
pipelines-as-code[bot] merged 2 commits intotektoncd:mainfrom
chmouel:misc-docs

Conversation

@chmouel
Copy link
Copy Markdown
Member

@chmouel chmouel commented Apr 10, 2025

  • Replaced the provider support table with a checklist format that is
    easier to read and update than emojis.

  • Updated "Gitea" entry to "Gitea/Forgejo" since forgejo is going to
    be our preferred Gitea fork (for fedora support in the future).

  • Refined wording regarding provider documentation updates.

  • docs: Document available Hugo shortcodes

    • Added a new section to the developer documentation detailing Hugo shortcodes.
    • Included links to the hugo-book theme documentation and demo for reference.
    • Documented custom shortcodes tech_preview and support_matrix.
    • Provided usage examples and explanations for the custom shortcodes.

    Signed-off-by: Chmouel Boudjnah chmouel@redhat.com

chmouel added 2 commits April 10, 2025 10:56
* Replaced the provider support table with a checklist format that is
  easier to read and update than emojis.
* Updated "Gitea" entry to "Gitea/Forgejo" since forgejo is going to
  be our preferred Gitea fork (for fedora support in the future).
* Refined wording regarding provider documentation updates.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
- Added a new section to the developer documentation detailing Hugo shortcodes.
- Included links to the `hugo-book` theme documentation and demo for reference.
- Documented custom shortcodes `tech_preview` and `support_matrix`.
- Provided usage examples and explanations for the custom shortcodes.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Copilot AI review requested due to automatic review settings April 10, 2025 08:58
@chmouel chmouel changed the title - **chore: Update pullrequest template provider check** Misc docs update Apr 10, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

#### tech_preview

```markdown
{ {< tech_preview "Feature Name" >}}
Copy link

Copilot AI Apr 10, 2025

Choose a reason for hiding this comment

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

The shortcode syntax for tech_preview contains extra spaces between the opening curly braces. It should be modified to use the correct Hugo shortcode format: '{{< tech_preview "Feature Name" >}}'.

Suggested change
{ {< tech_preview "Feature Name" >}}
{{< tech_preview "Feature Name" >}}

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

that's in purpose, since i can't get it otherwise to don't render the markdown.

@zakisk
Copy link
Copy Markdown
Member

zakisk commented Apr 10, 2025

/lgtm

Copy link
Copy Markdown

@pipelines-as-code pipelines-as-code bot left a comment

Choose a reason for hiding this comment

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

Congrats @chmouel your PR Has been approved 🎉

✅ Pull Request Approved

Approval Status:

  • Required Approvals: 1
  • Current Approvals: 1

👥 Reviewers Who Approved:

Reviewer Permission Level Approval Status
@zakisk admin

📝 Next Steps

  • Ensure all required checks pass
  • Comply with branch protection rules
  • Request a maintainer to merge using the /merge command (or merge it
    directly if you have repository permission).

Automated by the PAC Boussole 🧭

@zakisk
Copy link
Copy Markdown
Member

zakisk commented Apr 10, 2025

/merge

@pipelines-as-code pipelines-as-code bot merged commit b1aeae0 into tektoncd:main Apr 10, 2025
5 checks passed
@pipelines-as-code
Copy link
Copy Markdown

✅ PR Successfully Merged

  • Merge method: rebase
  • Merged by: @zakisk
  • Total approvals: 1/1

Approvals Summary:

Reviewer Permission Status
@zakisk admin

Thank you @chmouel for your valuable contribution! 🎉

Automated by the PAC Boussole 🧭

@chmouel chmouel deleted the misc-docs branch April 10, 2025 15:04
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.

3 participants