Skip to content

Commit b1aeae0

Browse files
chmouelpipelines-as-code[bot]
authored andcommitted
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 <[email protected]>
1 parent 2a9461c commit b1aeae0

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/content/docs/dev/_index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,39 @@ need to go to this URL:
252252
There is a drop-down at the bottom of the page to let you change the older
253253
major version.
254254

255+
### Documentation shortcode
256+
257+
The hugo-book theme has several shortcodes that are used to do different things
258+
for the documentation.
259+
260+
See the demo site of hugo-book on how to use them here <https://github.com/alex-shpak/hugo-book#shortcodes>
261+
262+
And the demo on how to use them here:
263+
264+
<https://hugo-book-demo.netlify.app/>
265+
266+
We have as well some custom ones, you can see them in this directory:
267+
268+
<https://github.com/openshift-pipelines/pipelines-as-code/tree/main/docs/layouts/shortcodes>
269+
270+
See below on how to use them, feel free to grep around the documentation to see how they are actually used.
271+
272+
#### tech_preview
273+
274+
```markdown
275+
{ {< tech_preview "Feature Name" >}}
276+
```
277+
278+
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.
279+
280+
#### support_matrix
281+
282+
```markdown
283+
{ {< support_matrix github_app="true" github_webhook="true|false" gitea="true|false" gitlab="true|false" bitbucket_cloud="true|false" bitbucket_datacenter="true|false" >}}
284+
```
285+
286+
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.
287+
255288
## Documentation when we are doing the Release Process
256289

257290
- See here [release-process]({{< relref "/docs/dev/release-process.md" >}})

0 commit comments

Comments
 (0)