Skip to content

Commit 5086729

Browse files
add readme to explain how this directory is handled
Generated by cursor
1 parent 652fa29 commit 5086729

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
= Dynamic plugins reference module
2+
3+
Most of the reference content in this directory is not authored here. It is copied from the Red Hat Developer Hub (RHDH) plugin catalog index OCI image at build/sync time.
4+
5+
== Files fetched from the plugin catalog index
6+
7+
The script `rhdh-supported-plugins.sh` pulls pre-built documentation from the plugin catalog index image and copies these files into this directory:
8+
9+
* `con-preinstalled-dynamic-plugins.adoc`
10+
* `ref-deprecated-plugins.adoc`
11+
* `ref-ga-plugins.adoc`
12+
* `ref-technology-preview-plugins.adoc`
13+
* `rhdh-supported-plugins.csv`
14+
15+
The image is published at `quay.io/rhdh/plugin-catalog-index`. The tag is derived from the docs branch:
16+
17+
* `release-1.10` → `1.10`
18+
* `main` → `next`
19+
20+
Content is extracted from the `extend_dynamic-plugins-reference/` path inside the image.
21+
22+
== Files maintained in this repository
23+
24+
These files are not fetched from the catalog index:
25+
26+
* `ref-community-supported-plugins.adoc` — generated by `rhdh-supported-plugins.sh` from https://github.com/redhat-developer/rhdh-plugin-export-overlays[redhat-developer/rhdh-plugin-export-overlays]
27+
* `ref-community-supported-plugins.template.adoc` — template used by the script above
28+
* `ref-other-installable-plugins.adoc` — hand-maintained reference
29+
* `snip-dynamic-plugins-configuring-note.adoc` — shared snippet
30+
* `rhdh-supported-plugins.sh` — sync script for this module
31+
* `README.adoc` — this file
32+
33+
== Contributing to the dynamic plugins tables
34+
35+
Do not edit the fetched files directly in this repository. Changes will be overwritten the next time the sync script or the automated workflow runs.
36+
37+
To add or update Red Hat supported plugin tables (GA, Tech Preview, deprecated, preinstalled plugins, or the CSV), contribute in the *RHDH plugin catalog midstream repository*
38+
Replace `release-1.10` with the branch you are working on.
39+
40+
To update only the community plugins table, changes belong in https://github.com/redhat-developer/rhdh-plugin-export-overlays[redhat-developer/rhdh-plugin-export-overlays] instead. Run the script with `--skip-tables` to regenerate only that file:
41+
42+
== Automation
43+
44+
The GitHub Actions workflow `.github/workflows/generate-supported-plugins-pr.yml` runs `rhdh-supported-plugins.sh` on a schedule and opens a pull request when the catalog index or overlays repo content changes.
45+
46+
== Requirements
47+
48+
Running the sync script locally requires:
49+
50+
* `skopeo`
51+
* `jq`
52+
* `yq` (the https://kislyuk.github.io/yq/[kislyuk/jq-wrapper] version, not mikefarah/yq)

0 commit comments

Comments
 (0)