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

Improve example on app yamls to avoid confusion on versioning #1813

Closed
RealAnna opened this issue Aug 1, 2023 · 2 comments · Fixed by #1821
Closed

Improve example on app yamls to avoid confusion on versioning #1813

RealAnna opened this issue Aug 1, 2023 · 2 comments · Fixed by #1821
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@RealAnna
Copy link
Contributor

RealAnna commented Aug 1, 2023

this doc and this one confuse users since they use X.Y and X.Y.Z format to refer to versions of app and workloads. We need for the examples to stress out that there is no correlation between app version and workload version and that anything can be used as a version i.e. latest, myvers12.5, my_v24

@RealAnna RealAnna added the documentation Improvements or additions to documentation label Aug 1, 2023
@hirentimbadiya
Copy link
Contributor

@RealAnna, In first doc we can update the application manifest (app.yaml) to remove the version numbers from the workload definitions and mention that version strings can be any arbitrary value.
In second doc we can update the "Synopsis" section to clarify that the version strings for workloads can be any string and not just X.Y.Z format.

I would like to work on this and open to your suggestions, can you please assign me this issue.

@RealAnna
Copy link
Contributor Author

RealAnna commented Aug 1, 2023

@hirentimbadiya yes this is good, and maybe add a "latest" in the second file? I will assign you 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants