CONSOLE-3169: Publish console dynamic plugin extension and api docs

[TheRealJon]

Manually publish dynamic plugin SDK API docs and add CI checks to ensure generated files stay up to date.

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.

https://issues.redhat.com/browse/CONSOLE-3169

[spadgett]

@TheRealJon If we check in the generated doc files, we should add something to CI that makes sure they're updated when things changed (similar to what we do with yarn.lock).

@vojtechszocs @christianvogt @bipuladh FYI

[spadgett]

Can we remove the generated folder from gitignore in the SDK package?

[TheRealJon]

@spadgett

@TheRealJon If we check in the generated doc files, we should add something to CI that makes sure they're updated when things changed (similar to what we do with yarn.lock).

Yeah, definitely. I was going to look into this next

Can we remove the generated folder from gitignore in the SDK package?

I opted to move the docs out of the generated folder since those are the only files we need to check in. The other artifacts in the generated folder can still be ignored. I also thought it would be good to keep /generated/ out of the URL path for GitHub Pages.

[TheRealJon]

/label tide/merge-method-squash

[spadgett]

/lgtm

[TheRealJon]

/hold

There seems to be an issue with the generation script. It's generating different source code links in CI and local environments.

[TheRealJon]

/hold cancel

I fixed the issue with the link generation logic.

[spadgett]

/lgtm

[andrewballantyne]

My original issues were around how we could end up with multiple doc versions. a 4.11 pointing at master would be a bad thing. But it's just the latest docs.

This is a bit of an oddity... GitHub pages is a single version -- the latest. So any link to master, as long as we keep it up to date, will work.

However anyone looking at the READMEs in previous version, they will get an undesired link reference.

I think we should go with this, and start thinking on how we can get the docs to be more future proof.

[TheRealJon]

QE Approver
/assign @yapei

Docs Approver:
/assign @opayne1

PX Approver:
/assign @RickJWagner

@spadgett @andrewballantyne I've updated all of the github links to the release-4.11 branch. This will need another lgtm.

[RickJWagner]

/label px-approved

[opayne1]

/label docs-approved

[TheRealJon]

@yapei I've updated per your comment

[andrewballantyne]

/lgtm

[andrewballantyne]

/retest

[andrewballantyne]

/lgtm

[andrewballantyne]

Looks like it had an issue with hosting the cluster for e2e -- then crashed frontend with it. Retrying.

/retest

[andrewballantyne]

/lgtm

[yapei]

/label qe-approved

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andrewballantyne, spadgett, TheRealJon, yapei, zherman0

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [TheRealJon,spadgett]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci-robot]

/retest-required

Remaining retests: 2 against base HEAD 413429e and 8 for PR HEAD 3cdee25 in total

[openshift-ci]

@TheRealJon: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.