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

Backport of Docs/intentions refactor docs day 2022 into release/1.15.x #16775

Conversation

hc-github-team-consul-core
Copy link
Collaborator

Backport

This PR is auto-generated from #16758 to be assessed for backporting due to the inclusion of the label backport/1.15.

WARNING automatic cherry-pick of commits failed. Commits will require human attention.

merge conflict error: unable to process merge commit: "eb192461c458f3485a10036440bfe0f3b0639b19", automatic backport requires rebase workflow

The below text is copied from the body of the original PR.


Description

This PR applies the draft of the refactored intentions content that we started during the 12/2022 docs day.

  1. Converted the service intentions configuration entry to the new mode/spec format.
  2. Separated usage information into a new usage page
  3. Revised the existing page into an overview page

Links

Preview

Docs day drafts:

PR Checklist

  • external facing docs updated
  • not a security concern

Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/intentions-refactor-docs-day-2022/completely-current-stag branch 2 times, most recently from 42bc46c to 6d23be4 Compare March 24, 2023 22:16
Copy link
Collaborator

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Mar 24, 2023
* converted intentions conf entry to ref CT format

* set up intentions nav

* add page for intentions usage

* final intentions usage page

* final intentions overview page

* fixed old relative links

* updated diagram for overview

* updated links to intentions content

* fixed typo in updated links

* rename intentions overview page file to index

* rollback link updates to intentions overview

* fixed nav

* Updated custom HTML in API and CLI pages to MD

* applied suggestions from review to index page

* moved conf examples from usage to conf ref

* missed custom HTML section

* applied additional feedback

* Apply suggestions from code review

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>

* updated headings in usage page

* renamed files and udpated nav

* updated links to new file names

* added redirects and final tweaks

* typo

---------

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
@trujillo-adam trujillo-adam marked this pull request as ready for review March 24, 2023 23:06
@trujillo-adam trujillo-adam requested a review from a team as a code owner March 24, 2023 23:06
@trujillo-adam trujillo-adam merged commit a3d05b6 into release/1.15.x Mar 24, 2023
@trujillo-adam trujillo-adam deleted the backport/docs/intentions-refactor-docs-day-2022/completely-current-stag branch March 24, 2023 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants