rancher / elemental-docs

Documentation for everything around Rancher Elemental
https://elemental.docs.rancher.com
Apache License 2.0
6 stars 20 forks source link

Document channels best practices #343

Closed anmazzotti closed 4 months ago

anmazzotti commented 4 months ago

Closes #341

Note the Channels list is referencing the highly experimental OBS new project, this is why I didn't include this documentation on 1.5 yet, but it's safe to be backported once we can reference stable SLE Micro 5.5 channels.

netlify[bot] commented 4 months ago

Deploy Preview for elemental-docs-staging ready!

Name Link
Latest commit 17ae832ff44d4b8eedd1c9006720dcca4989c59a
Latest deploy log https://app.netlify.com/sites/elemental-docs-staging/deploys/6666ae2182ab2c0008150ccb
Deploy Preview https://deploy-preview-343--elemental-docs-staging.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

anmazzotti commented 4 months ago

Coverage of the OS channel feature 🎉 Great job!

There is one thing we still have to make explicit: that channels images get updated "automatically" to update the list of OS images. We may also document what happens with the "older" images removed (i.e., will stay there and could be deleted manually).

I did not manage to implement the limit on the channels and we should also implement annotations/labels on the operator side and visualize them on the UI so that users know which versions are no longer synced. We have issues for all of this when we feel like picking it up.

One point to consider: moving the list of available channels to a dedicated page (for quicker reference), then we can just link to it. Moving in the release notes page could be another option.

Good point, probably worth to move it when we add more channels/flavors with 6.0 images.