Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use the che-docs container for github workflow actions in che-docs #18865

Closed
themr0c opened this issue Jan 22, 2021 · 9 comments
Closed

Use the che-docs container for github workflow actions in che-docs #18865

themr0c opened this issue Jan 22, 2021 · 9 comments
Assignees
Labels
area/ci CI build and releases, PR testing, & whitelabel/productization issues area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.

Comments

@themr0c
Copy link
Contributor

themr0c commented Jan 22, 2021

In order to have every process in che-docs use exactly the same version of the tools, use the quay.io/eclipse/che-docs container in GitHub workflow actions for all processes that have tools built in the che-docs containers:

  • Execute antora
  • Execute vale
  • Execute linkchecker
  • Execute bash scripts
@themr0c themr0c added kind/task Internal things, technical debt, and to-do tasks to be performed. area/ci CI build and releases, PR testing, & whitelabel/productization issues area/doc Issues related to documentation labels Jan 22, 2021
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Jan 22, 2021
@benoitf benoitf self-assigned this Jan 22, 2021
@nickboldt
Copy link
Contributor

nickboldt commented Jan 22, 2021

@themr0c
Copy link
Contributor Author

themr0c commented Jan 22, 2021

Yes that's not for the release script but for the other ones!

@nickboldt
Copy link
Contributor

So instead of

           yarn
           ./node_modules/.bin/antora generate antora-playbook.yml

what are you suggesting should be done instead? How do you want quay.io/eclipse/che-docs used?

@nickboldt nickboldt added severity/P2 Has a minor but important impact to the usage or development of the system. and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Jan 22, 2021
@themr0c
Copy link
Contributor Author

themr0c commented Jan 22, 2021

What we do in devfile and Jenkinsfile: run antora / linkchecker / vale directly in the quay.io/eclipse/che-docs container.
For vale it's also quite important to keep same version because of some surprises with upgrades.

@yhontyk
Copy link

yhontyk commented Jan 25, 2021

Issue in docs Jira https://issues.redhat.com/browse/RHDEVDOCS-2537

@themr0c
Copy link
Contributor Author

themr0c commented Jan 26, 2021

Example of surprise: linkchecker running fine using the che-docs image, broken using the official and outdated linkchecker image: eclipse-che/che-docs#1801

@themr0c
Copy link
Contributor Author

themr0c commented Jan 26, 2021

Example:

In the middle, linkchecker executed using che-docs container.
On the right, linkchecker executed using linkchecker/lickchecker container.

Options are not taken into account, a big subset of the URLs is not checked:

Screenshot from 2021-01-26 15-27-47

Screenshot from 2021-01-26 15-33-23

@benoitf
Copy link
Contributor

benoitf commented Feb 9, 2021

@themr0c should we close this issue as you've done by yourself some enhancements ?

@themr0c
Copy link
Contributor Author

themr0c commented Mar 2, 2021

You helped a lot. I just checked, seems we are good yes.

@themr0c themr0c closed this as completed Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci CI build and releases, PR testing, & whitelabel/productization issues area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system.
Projects
None yet
Development

No branches or pull requests

5 participants