Skip to content

Docs/igw docs day refactor#17259

Merged
trujillo-adam merged 13 commits intomainfrom
docs/igw-docs-day-refactor
May 17, 2023
Merged

Docs/igw docs day refactor#17259
trujillo-adam merged 13 commits intomainfrom
docs/igw-docs-day-refactor

Conversation

@trujillo-adam
Copy link
Contributor

@trujillo-adam trujillo-adam commented May 8, 2023

Description

This PR refactors the existing ingress gateway documentation into overview, usage, and configuration reference content types. We edited some content for clarity and so that it fit into the content type paradigm, but it is mostly unchanged. Please review for accuracy.

Preview pages:

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@trujillo-adam trujillo-adam added type/docs Documentation needs to be created/updated/clarified pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test backport/1.15 This release series is no longer active on CE. Use backport/ent/1.15. labels May 8, 2023
@trujillo-adam trujillo-adam marked this pull request as ready for review May 9, 2023 14:17
@trujillo-adam trujillo-adam requested a review from a team as a code owner May 9, 2023 14:17
@trujillo-adam trujillo-adam requested review from a team and JadhavPoonam and removed request for a team May 9, 2023 14:18
Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
Copy link
Contributor

@im2nguyen im2nguyen left a comment

Choose a reason for hiding this comment

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

Looks good, a couple small nits, but pre-approving so you're not blocked from merging

I noticed you used <CodeBlock> instead of <CodeBlockConfig>, can you please change this before merging? Also, this is a nit, but newlines are inconsistent after headings and codefences, would be nice if we can be consistent with a single new line after each one

Copy link
Contributor

@im2nguyen im2nguyen left a comment

Choose a reason for hiding this comment

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

Looks good, a couple small nits, but pre-approving so you're not blocked from merging

I noticed you used <CodeBlock> instead of <CodeBlockConfig>, can you please change this before merging? Also, this is a nit, but newlines are inconsistent after headings and codefences, would be nice if we can be consistent with a single new line after each one

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
@trujillo-adam trujillo-adam merged commit 94ea0a9 into main May 17, 2023
@trujillo-adam trujillo-adam deleted the docs/igw-docs-day-refactor branch May 17, 2023 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/1.15 This release series is no longer active on CE. Use backport/ent/1.15. pr/no-changelog PR does not need a corresponding .changelog entry 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.

4 participants