Repository: openshift-pipelines/pipelines-as-code
Pull request #2038: Misc docs update
Author: login: chmouel
Created: 2025-04-10T08:58:53Z | Merged: 2025-04-10T11:22:03Z

  - 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>
  


Diff:
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 7896c3c279..4a8d9cb557 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -20,13 +20,11 @@
 
 - If adding a provider feature, fill in the following details:
 
-| Git Provider          | Supported |
-|-----------------------|-----------|
-| GitHub App            | ✅️        |
-| GitHub Webhook        | ❌️        |
-| Gitea                 | ❌️        |
-| GitLab                | ❌️        |
-| Bitbucket Cloud       | ❌️        |
-| Bitbucket Data Center | ❌️        |
-
-  (update the documentation accordingly)
+  - [ ] GitHub App
+  - [ ] GitHub Webhook
+  - [ ] Gitea/Forgejo
+  - [ ] GitLab
+  - [ ] Bitbucket Cloud
+  - [ ] Bitbucket Data Center
+
+  (update the provider documentation accordingly)
diff --git a/docs/content/docs/dev/_index.md b/docs/content/docs/dev/_index.md
index 08746ad1a9..0eda0fc191 100644
--- a/docs/content/docs/dev/_index.md
+++ b/docs/content/docs/dev/_index.md
@@ -252,6 +252,39 @@ need to go to this URL:
 There is a drop-down at the bottom of the page to let you change the older
 major version.
 
+### Documentation shortcode
+
+The hugo-book theme has several shortcodes that are used to do different things
+for the documentation.
+
+See the demo site of hugo-book on how to use them here <https://github.com/alex-shpak/hugo-book#shortcodes>
+
+And the demo on how to use them here:
+
+<https://hugo-book-demo.netlify.app/>
+
+We have as well some custom ones, you can see them in this directory:
+
+<https://github.com/openshift-pipelines/pipelines-as-code/tree/main/docs/layouts/shortcodes>
+
+See below on how to use them, feel free to grep around the documentation to see how they are actually used.
+
+#### tech_preview
+
+```markdown
+{ {< tech_preview "Feature Name" >}}
+```
+
+This shortcode creates a red warning blockquote indicating that a feature is in Technology Preview status. It takes one parameter - the name of the feature. The output shows a warning message that the specified feature is not supported for production use and is provided for early testing and feedback.
+
+#### support_matrix
+
+```markdown
+  { {< support_matrix github_app="true" github_webhook="true|false" gitea="true|false" gitlab="true|false" bitbucket_cloud="true|false" bitbucket_datacenter="true|false" >}}
+```
+
+This shortcode generates a compatibility table showing which Git providers support a particular feature. Each parameter accepts "true" or "false" values, displaying checkmarks (✅) or cross marks (❌) accordingly. The table lists all major Git providers (GitHub App, GitHub Webhook, Gitea, GitLab, Bitbucket Cloud, and Bitbucket Data Center) with their support status for the feature.
+
 ## Documentation when we are doing the Release Process
 
 - See here [release-process]({{< relref "/docs/dev/release-process.md" >}})


Reviews:
user: login: copilot-pull-request-reviewer[bot]
body: 

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




state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-10T08:59:14Z
user: login: chmouel
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-04-10T08:59:47Z
user: login: pipelines-as-code[bot]
body: 
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](https://github.com/openshift-pipelines/pac-boussole) 🧭* 


state: APPROVED
author_association: NONE
submitted_at: 2025-04-10T11:20:40Z

Review comments:
diff_hunk: @@ -252,6 +252,39 @@ need to go to this URL:
 There is a drop-down at the bottom of the page to let you change the older
 major version.
 
+### Documentation shortcode
+
+The hugo-book theme has several shortcodes that are used to do different things
+for the documentation.
+
+See the demo site of hugo-book on how to use them here <https://github.com/alex-shpak/hugo-book#shortcodes>
+
+And the demo on how to use them here:
+
+<https://hugo-book-demo.netlify.app/>
+
+We have as well some custom ones, you can see them in this directory:
+
+<https://github.com/openshift-pipelines/pipelines-as-code/tree/main/docs/layouts/shortcodes>
+
+See below on how to use them, feel free to grep around the documentation to see how they are actually used.
+
+#### tech_preview
+
+```markdown
+{ {< tech_preview "Feature Name" >}}
path: docs/content/docs/dev/_index.md
user: login: Copilot
body: 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" >}}'.
```suggestion
{{< tech_preview "Feature Name" >}}
```
created_at: 2025-04-10T08:59:14Z
author_association: CONTRIBUTOR
diff_hunk: @@ -252,6 +252,39 @@ need to go to this URL:
 There is a drop-down at the bottom of the page to let you change the older
 major version.
 
+### Documentation shortcode
+
+The hugo-book theme has several shortcodes that are used to do different things
+for the documentation.
+
+See the demo site of hugo-book on how to use them here <https://github.com/alex-shpak/hugo-book#shortcodes>
+
+And the demo on how to use them here:
+
+<https://hugo-book-demo.netlify.app/>
+
+We have as well some custom ones, you can see them in this directory:
+
+<https://github.com/openshift-pipelines/pipelines-as-code/tree/main/docs/layouts/shortcodes>
+
+See below on how to use them, feel free to grep around the documentation to see how they are actually used.
+
+#### tech_preview
+
+```markdown
+{ {< tech_preview "Feature Name" >}}
path: docs/content/docs/dev/_index.md
user: login: chmouel
body: that's in purpose, since i can't get it otherwise to don't render the markdown.
created_at: 2025-04-10T08:59:46Z
author_association: MEMBER

PR comments:
user: login: zakisk
created_at: 2025-04-10T11:20:25Z
body: /lgtm
author_association: MEMBER
user: login: zakisk
created_at: 2025-04-10T11:21:52Z
body: /merge
author_association: MEMBER
user: login: pipelines-as-code[bot]
created_at: 2025-04-10T11:22:05Z
body: 
### ✅ 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](https://github.com/openshift-pipelines/pac-boussole) 🧭* 


author_association: NONE