refactors README to send users to docs & safely handle existing anchors #598
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.