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
[doc] Update manifest to reference versioning spec #17549
Conversation
Currently only `version-string` is included in the manifest-files.md. However there are more variants of this field. This PR adds a cross link to the versioning specification. fixes #17548
@NancyLi1013 maybe we should remove the whole |
I agree with your suggestions. This section seems outdated. But since it is about version naming, we cannot remove it directly. We can rewrite this section. What do you think? |
I was wondering if the changes introduced with 66619e0 are sufficient. Since all details are available in the specification (with examples) and the needed information, which fields exists are given in the table added with the mentioned commit |
Co-authored-by: NancyLi1013 <46708020+NancyLi1013@users.noreply.github.com>
@NancyLi1013 the "thumbs up" is the indication that we will drop |
Currently, it might be not. I think we should rewrite this section. But I have no idea how to make it more reasonable. We have supported several kinds of version, only listing Do you have any suggestion? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Further tweaks and consolidation is needed, but this is certainly an incremental improvement.
@NancyLi1013 From my point of view, the table with the possible fields would be sufficient. Since, in my opinion, all the information we would write here would be duplicated with the specification. Maybe first merge these changes and discuss further changes in discussions or in a seperate PR? |
Thanks for the PR! |
Currently only
version-string
is included in the manifest-files.md. However there are more variants of this field. This PR adds a cross link to the versioning specification.fixes #17548