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

Document the stabilized BitOps versioning in the docs #278

Merged
merged 4 commits into from
Aug 17, 2022
Merged

Conversation

arm4b
Copy link
Member

@arm4b arm4b commented Aug 16, 2022

Following the collective effort in the discussions (#203), WIKI and CD work, document the stabilized official BitOps versioning, showing an example with a table and explanation on how images are named and tagged in different scenarios.

@arm4b arm4b added documentation 📗 Improvements or additions to documentation enhancement ✨ New feature or request labels Aug 16, 2022
@arm4b arm4b changed the title Make the BitOps versioning documented in the docs Document the stabilized BitOps versioning in the docs Aug 16, 2022
mkdocs.yml Outdated
Comment on lines 41 to 44
- Development:
- Local development: development-local.md
- Versioning: versioning.md
- Custom Images: custom-image.md
Copy link
Member Author

@arm4b arm4b Aug 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new page was placed under the Development category, but I'm open to suggestions if anyone has a better idea for the Versioning page category.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, I would put it under configuration. Development to me is more about customizing an image.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a thought.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Configuration" section would work better indeed.
Updated in 50e358b, thanks!

@arm4b arm4b merged commit 07b5c1c into main Aug 17, 2022
@arm4b arm4b deleted the enh/versioning branch August 17, 2022 11:52
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 enhancement ✨ New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants