Skip to content

Commit 0ce6463

Browse files
authored
Publish console dynamic plugin extension and api docs (openshift#11633)
`README.md` Update root README to provide easier navigation to package docs. `frontend/packages/console-dynamic-plugin-sdk/README.md` Update console dynamic plugin SDK README to provide easier navigation to API and Console Extension docs. `frontend/packages/console-dynamic-plugin-sdk/docs` Generate dynamic plugin docs in this dir so that they are not ignored by git and /generated/ is not included in the GitHub Pages URL path. `frontend/packages/console-dynamic-plugin-sdk/scripts/generate-doc.ts` Refactor and simplify GitHub link generation logic `frontend/packages/console-dynamic-plugin-sdk/scripts/package-definitions.ts` Update location of generated docs so that they are copied into dist `test-frontend.sh` Reorder the checks in this file so that the least time-consuming and compute-intensive steps come first, meaning we will fail faster.
1 parent 413429e commit 0ce6463

File tree

7 files changed

+2763
-79
lines changed

7 files changed

+2763
-79
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -469,3 +469,26 @@ We support the latest versions of the following browsers:
469469
- Firefox
470470

471471
IE 11 and earlier is not supported.
472+
473+
## Frontend Packages
474+
- [ceph-storage-plugin](./frontend/packages/ceph-storage-plugin/README.md)
475+
476+
- [console-dynamic-plugin-sdk](./frontend/packages/console-dynamic-plugin-sdk/README.md)
477+
[[API]](./frontend/packages/console-dynamic-plugin-sdk/docs/api.md)
478+
[[Console Extensions]](./frontend/packages/console-dynamic-plugin-sdk/docs/console-extensions.md)
479+
480+
- [console-plugin-shared](./frontend/packages/console-plugin-shared/README.md)
481+
482+
- [dev-console](./frontend/packages/dev-console/README.md)
483+
484+
- [eslint-plugin-console](./frontend/packages/eslint-plugin-console/README.md)
485+
486+
- [integration-tests-cypress](./frontend/packages/integration-tests-cypress/README.md)
487+
488+
- [knative-plugin](./frontend/packages/knative-plugin/README.md)
489+
490+
- operator-lifecycle-manager
491+
[[Descriptors README]](./frontend/packages/operator-lifecycle-manager/src/components/descriptors/README.md)
492+
[[Descriptors API Reference]](./frontend/packages/operator-lifecycle-manager/src/components/descriptors/reference/reference.md)
493+
494+
- [rhoas-plugin](./frontend/packages/rhoas-plugin/README.md)

frontend/packages/console-dynamic-plugin-sdk/README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@ released, installed and upgraded independently from each other. To ensure compat
99
other plugins, each plugin must declare its dependencies using [semantic version](https://semver.org/)
1010
ranges.
1111

12-
See the
13-
[OpenShift Console Dynamic Plugins feature page](https://github.com/openshift/enhancements/blob/master/enhancements/console/dynamic-plugins.md)
14-
for a high level overview of dynamic plugins in relation to OLM operators and cluster administration.
12+
## Related Documentation
13+
*[Extension Documentation](./docs/console-extensions.md)* - Detailed documentation of every available console extension point.
14+
15+
*[API Documentation](./docs/api.md)* - Detailed documentation of hooks, components, and other APIs provided by this package.
16+
17+
*[OpenShift Console Dynamic Plugins feature page](https://github.com/openshift/enhancements/blob/master/enhancements/console/dynamic-plugins.md)* - A high level overview of dynamic plugins in relation to OLM operators and cluster administration.
18+
1519

1620
Example project structure:
1721

0 commit comments

Comments
 (0)