Skip to content

docs: Updates k8s annotation docs#13809

Merged
david-yu merged 5 commits intomainfrom
nicoleta-k8s-annotations
Jul 22, 2022
Merged

docs: Updates k8s annotation docs#13809
david-yu merged 5 commits intomainfrom
nicoleta-k8s-annotations

Conversation

@NicoletaPopoviciu
Copy link
Copy Markdown
Collaborator

Updates k8s annotation docs for the options added in hashicorp/consul-k8s#1315.

Description

Describe why you're making this change, in plain English.

Testing & Reproduction steps

  • In the case of bugs, describe how to replicate
  • If any manual tests were done, document the steps and the conditions to replicate
  • Call out any important/ relevant unit tests, e2e tests or integration tests you have added or are adding

Links

Include any links here that might be helpful for people reviewing your PR (Tickets, GH issues, API docs, external benchmarks, tools docs, etc). If there are none, feel free to delete this section.

Please be mindful not to leak any customer or confidential information. HashiCorp employees may want to use our internal URL shortener to obfuscate links.

PR Checklist

  • updated test coverage
  • external facing docs updated
  • not a security concern

Updates k8s annotation docs for the  options added in hashicorp/consul-k8s#1315.
@NicoletaPopoviciu NicoletaPopoviciu requested a review from a team as a code owner July 19, 2022 23:44
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Jul 19, 2022
Copy link
Copy Markdown
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

Overall LGTM to me with these minor suggestions.

Please let me know if you have any questions or need any further assistance!

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
@david-yu
Copy link
Copy Markdown
Contributor

I added some more detail here about how to populate the actual values for this annotation, as it is not very apparent on how to do based on the description that was provided.

@david-yu david-yu changed the title Updates k8s annotation docs docs: Updates k8s annotation docs Jul 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr/no-metrics-test type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants