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

Remove VERSION file in che-docs; keep antora-playbook.yml up to date instead #18864

Closed
themr0c opened this issue Jan 22, 2021 · 3 comments
Closed
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

The content of the PR is always false. The master branch contains the documentation for the released version of Che but the bot is always trying to update the file to the next version. Very confusing.

Example erroneous PR: eclipse-che/che-docs#1806

I am not aware of any process in che-docs using the VERSION file. We should probably remove it completely to remove a source of confusion.

The only relevant place to define the Che version should be in https://github.com/eclipse/che-docs/blob/master/antora-playbook.yml

    prod-prev-ver-major: 6
    prod-prev-ver: 7.22
    prod-ver-major: 7
    prod-ver: 7.23
    prod-ver-patch: 7.23.2

If we want to keep an automated process, please make sure it is setting the released version of Che in antora-playbook.yml (as well as the previous version).

@themr0c themr0c added the kind/task Internal things, technical debt, and to-do tasks to be performed. label 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
@themr0c themr0c added area/doc Issues related to documentation area/ci CI build and releases, PR testing, & whitelabel/productization issues labels Jan 22, 2021
@nickboldt nickboldt added area/productization 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
@nickboldt
Copy link
Contributor

nickboldt commented Jan 22, 2021

So we'd want to update this bit of code:

https://github.com/eclipse/che-docs/pull/1802/files#diff-be36842270d47fd0f7dd297abbdf5c5ef7916efe78fd4617f5ca6a5fdcba421cR18-R19

to update antora-playbook.yml instead of VERSION file.

I suspect that fixing this issue will also mean that pages like https://www.eclipse.org/che/docs/che-7/end-user-guide/creating-and-configuring-a-new-workspace/ will be up to date (and thus show 7.25 instead of 7.23)

image

@nickboldt nickboldt changed the title github-actions should stop changing the content of the VERSION file in che-docs Remove VERSION file in che-docs; keep antora-playbook.yml up to date instead Jan 22, 2021
@nickboldt nickboldt assigned nickboldt and mkuznyetsov and unassigned nickboldt Jan 22, 2021
@yhontyk
Copy link

yhontyk commented Jan 25, 2021

Jira docs issue https://issues.redhat.com/browse/RHDEVDOCS-2538

@nickboldt
Copy link
Contributor

nickboldt commented Jan 29, 2021

PR for making playbook current w/ every weekly release: eclipse-che/che-docs#1823

Then PR to trigger the above from a che-operator release (push to master branch): eclipse-che/che-operator#657

Note that with these changes, we'll want to disable the bit of the che-release cico script that triggers changes to che-docs:

https://github.com/eclipse/che-release/pull/24/files#diff-00f10a3f2d34c8611e384da8b9b2b9283abcb69a4c3fa242e5a5ac5ba782abcfL113-R124

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