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/cluster peering 1.15 updates into release/1.15.x #16398

Conversation

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

Backport

This PR is auto-generated from #16291 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: POST https://api.github.com/repos/hashicorp/consul/merges: 409 Merge conflict []

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


Description

For the Consul v1.15 release, we've made significant improvements to the Cluster Peering Documentation. These edits fall into two main categories:

  1. The Consul 1.15 Strawman included a list of requested documentation improvements. Each of the request improvements has been implemented in the documentation.
  2. The pages were divided according to the documentation content types that Consul Education has under development. The three previous pages are now six discrete pages, with layouts and names that reflect the content types.

Links

PR Checklist

  • updated test coverage
  • 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/cluster-peering-1-15/blatantly-normal-cod branch from 22050c0 to a814be6 Compare February 23, 2023 17:59
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/cluster-peering-1-15/blatantly-normal-cod branch from a814be6 to 22050c0 Compare February 23, 2023 17:59
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 Feb 23, 2023
@boruszak boruszak marked this pull request as ready for review February 23, 2023 18:43
@boruszak boruszak requested a review from a team as a code owner February 23, 2023 18:43
* initial commit

* initial commit

* Overview updates

* Overview page improvements

* More Overview improvements

* improvements

* Small fixes/updates

* Updates

* Overview updates

* Nav data

* More nav updates

* Fix

* updates

* Updates + tip test

* Directory test

* refining

* Create restructure w/ k8s

* Single usage page

* Technical Specification

* k8s pages

* typo

* L7 traffic management

* Manage connections

* k8s page fix

* Create page tab corrections

* link to k8s

* intentions

* corrections

* Add-on intention descriptions

* adjustments

* Missing </CodeTabs>

* Diagram improvements

* Final diagram update

* Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: David Yu <dyu@hashicorp.com>

* diagram name fix

* Fixes

* Updates to index.mdx

* Tech specs page corrections

* Tech specs page rename

* update link to tech specs

* K8s - new pages + tech specs

* k8s - manage peering connections

* k8s L7 traffic management

* Separated establish connection pages

* Directory fixes

* Usage clean up

* k8s docs edits

* Updated nav data

* CodeBlock Component fix

* filename

* CodeBlockConfig removal

* Redirects

* Update k8s filenames

* Reshuffle k8s tech specs for clarity, fmt yaml files

* Update general cluster peering docs, reorder CLI > API > UI, cross link to kubernetes

* Fix config rendering in k8s usage docs, cross link to general usage from k8s docs

* fix legacy link

* update k8s docs

* fix nested list rendering

* redirect fix

* page error

---------

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
@boruszak boruszak merged commit 42913d6 into release/1.15.x Feb 23, 2023
@boruszak boruszak deleted the backport/docs/cluster-peering-1-15/blatantly-normal-cod branch February 23, 2023 18:45
@nathancoleman nathancoleman mentioned this pull request Feb 23, 2023
3 tasks
@david-yu
Copy link
Contributor

@boruszak and @im2nguyen do you know why this is not showing up on consul.io? This was merged into the 1.15.x branch.

@im2nguyen
Copy link
Contributor

There was a build error -- digging into it.

@im2nguyen im2nguyen restored the backport/docs/cluster-peering-1-15/blatantly-normal-cod branch February 24, 2023 21:56
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.

5 participants