Skip to content

changelog: Add docs/examples changes + cleanups#22204

Merged
phlax merged 3 commits intoenvoyproxy:mainfrom
phlax:changelog-docs-examples
Jul 15, 2022
Merged

changelog: Add docs/examples changes + cleanups#22204
phlax merged 3 commits intoenvoyproxy:mainfrom
phlax:changelog-docs-examples

Conversation

@phlax
Copy link
Copy Markdown
Member

@phlax phlax commented Jul 14, 2022

Partial fix for #22065

includes cleanups:

  • fix incorrect yaml string type
  • narrow paragraph widths for easier viewing/editing in editor
  • fix/make consistent remaining literals
  • fix remaining initial capitalization

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message:
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

@phlax phlax changed the title changelog: Add docs/examples changes [WIP] changelog: Add docs/examples changes Jul 14, 2022
@phlax phlax marked this pull request as draft July 14, 2022 13:06
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 14, 2022

@repokitteh-read-only
Copy link
Copy Markdown

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/22204/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: a #22204 (comment) was created by @phlax.

see: more, trace.

@phlax phlax added this to the 1.23.0 milestone Jul 14, 2022
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 14, 2022

i will add some cleanups to this PR before i unWIP it, but we kinda need to land above PRs for it to be correct

Comment thread changelogs/current.yaml Outdated
@phlax phlax force-pushed the changelog-docs-examples branch from 85a7ba2 to b8ae309 Compare July 15, 2022 07:02
@phlax phlax changed the title [WIP] changelog: Add docs/examples changes [WIP] changelog: Add docs/examples changes + cleanups Jul 15, 2022
@phlax phlax force-pushed the changelog-docs-examples branch from 14a6799 to 0b67eb3 Compare July 15, 2022 07:48
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

@adisuissa i have tried to make the literals as consistent as possible

just this file throws up an interesting mix - names, acronyms and literals, where the distinction is not always clear cut

another example is numbers - i generally think dont literalize numbers - they would be localized in most cases - but eg response codes are a grey area - also numbers with a math operator maybe should be literals - but not sure about <0 or <0. A 0 as output probably should be a literal i think - ie you dont get back nothing you get back a 0 - there is an example of this in this file

either way i think this makes it a bit more consistent

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

@phlax phlax force-pushed the changelog-docs-examples branch 2 times, most recently from 99bd094 to 2f8928c Compare July 15, 2022 08:29
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

arggh - i just noticed that its not ordering alphabetically - ill try and fix now

@phlax phlax force-pushed the changelog-docs-examples branch from 2f8928c to 82a2480 Compare July 15, 2022 08:34
@phlax phlax marked this pull request as ready for review July 15, 2022 08:47
@phlax phlax changed the title [WIP] changelog: Add docs/examples changes + cleanups changelog: Add docs/examples changes + cleanups Jul 15, 2022
@phlax phlax force-pushed the changelog-docs-examples branch from 82a2480 to c7bad1a Compare July 15, 2022 08:49
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

/wait for #22205

@phlax phlax force-pushed the changelog-docs-examples branch from c7bad1a to f9699aa Compare July 15, 2022 13:22
@repokitteh-read-only repokitteh-read-only Bot added api deps Approval required for changes to Envoy's external dependencies and removed waiting labels Jul 15, 2022
@repokitteh-read-only
Copy link
Copy Markdown

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @adisuissa
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).
CC @envoyproxy/dependency-shepherds: Your approval is needed for changes made to (bazel/.*repos.*\.bzl)|(bazel/dependency_imports\.bzl)|(api/bazel/.*\.bzl)|(.*/requirements\.txt)|(.*\.patch).
envoyproxy/dependency-shepherds assignee is @wrowe

🐱

Caused by: #22204 was synchronize by phlax.

see: more, trace.

@phlax phlax added waiting and removed api deps Approval required for changes to Envoy's external dependencies labels Jul 15, 2022
@phlax phlax unassigned wrowe Jul 15, 2022
@phlax phlax force-pushed the changelog-docs-examples branch from 04677ce to 8123062 Compare July 15, 2022 13:50
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

i need fo check this over for dupes - the way the git merge works on this file can create them

@phlax phlax force-pushed the changelog-docs-examples branch from 8123062 to 9737616 Compare July 15, 2022 14:25
@phlax phlax marked this pull request as draft July 15, 2022 14:25
@phlax phlax force-pushed the changelog-docs-examples branch from 9737616 to f0befcd Compare July 15, 2022 14:44
@phlax phlax changed the title changelog: Add docs/examples changes + cleanups [WIP] changelog: Add docs/examples changes + cleanups Jul 15, 2022
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

@phlax phlax force-pushed the changelog-docs-examples branch from f0befcd to bb16f54 Compare July 15, 2022 15:12
@phlax phlax changed the title [WIP] changelog: Add docs/examples changes + cleanups changelog: Add docs/examples changes + cleanups Jul 15, 2022
@phlax phlax marked this pull request as ready for review July 15, 2022 15:20
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

@adisuissa i think this one should be ready for final review - im reasonably confident im not undoing any of the changes you just made, and ive rinsed out the dupes

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

Copy link
Copy Markdown
Contributor

@adisuissa adisuissa left a comment

Choose a reason for hiding this comment

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

Thanks.
Also in line 313 there "true" -> "true"

Comment thread changelogs/current.yaml Outdated
Comment thread changelogs/current.yaml Outdated
Comment thread changelogs/current.yaml Outdated
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

argg DCO

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jul 15, 2022

im gonna have to rebase/force to fix DCO - sorry - damn github!

phlax and others added 2 commits July 15, 2022 16:38
Partial fix for envoyproxy#22065

Signed-off-by: Ryan Northey <ryan@synca.io>
Co-authored-by: Adi (Suissa) Peleg <adip@google.com>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the changelog-docs-examples branch from 93843fd to 8c45913 Compare July 15, 2022 15:38
Signed-off-by: Ryan Northey <ryan@synca.io>
Copy link
Copy Markdown
Contributor

@adisuissa adisuissa left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@phlax phlax enabled auto-merge (squash) July 15, 2022 16:10
@phlax phlax merged commit d724ce8 into envoyproxy:main Jul 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants