This PR refactors the existing README to send users to the bottlerocket.dev documentation. This allows us to maintain documentation in a single place.
A substantial part of this PR exists to handle existing links to anchors. For example, if someone has an pre-existing bookmark or link for https://github.com/bottlerocket-os/bottlerocket-update-operator#installation, I don't want to just make that fall-back to the top of the github README, so I had to retain the heading to keep the anchor link and provide some sort of guide post to bottlerocket.dev . I'd be open to removing this after a transition period.
Note 1: Some of the linking depends on bottlerocket-os/bottlerocket-project-website#435, so I'm going to keep this draft until 435 is merged.
Note 2: The section Monitoring Cluster History and Metrics with Prometheus is still included in the readme. I plan to create a pattern for Containers on AWS to fill this gap, but not until approximately April. I'd like to merge this ASAP and replace the section in a subsequent PR after the pattern is published.
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.
Issue number: #596
Description of changes:
This PR refactors the existing README to send users to the bottlerocket.dev documentation. This allows us to maintain documentation in a single place.
A substantial part of this PR exists to handle existing links to anchors. For example, if someone has an pre-existing bookmark or link for
https://github.com/bottlerocket-os/bottlerocket-update-operator#installation, I don't want to just make that fall-back to the top of the github README, so I had to retain the heading to keep the anchor link and provide some sort of guide post to bottlerocket.dev . I'd be open to removing this after a transition period.Note 1: Some of the linking depends on bottlerocket-os/bottlerocket-project-website#435, so I'm going to keep this draft until 435 is merged.
Note 2: The section
Monitoring Cluster History and Metrics with Prometheusis still included in the readme. I plan to create a pattern for Containers on AWS to fill this gap, but not until approximately April. I'd like to merge this ASAP and replace the section in a subsequent PR after the pattern is published.Testing done:
With GRIP
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.