Skip to content

docs: Improve ordering and titles in API TOCs#23536

Merged
phlax merged 3 commits intoenvoyproxy:mainfrom
phlax:docs-api-toc-order
Oct 18, 2022
Merged

docs: Improve ordering and titles in API TOCs#23536
phlax merged 3 commits intoenvoyproxy:mainfrom
phlax:docs-api-toc-order

Conversation

@phlax
Copy link
Copy Markdown
Member

@phlax phlax commented Oct 18, 2022

Fix #22875

Related to #20238

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:]

Signed-off-by: Ryan Northey <ryan@synca.io>
@repokitteh-read-only
Copy link
Copy Markdown

Docs for this Pull Request will be rendered here:

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

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

🐱

Caused by: #23536 was opened by phlax.

see: more, trace.

@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 @htuch
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #23536 was opened by phlax.

see: more, trace.

@phlax phlax changed the title docs: Improve ordering in API TOCs [WIP] docs: Improve ordering in API TOCs Oct 18, 2022
@phlax phlax marked this pull request as draft October 18, 2022 10:21
@phlax phlax changed the title [WIP] docs: Improve ordering in API TOCs [WIP] docs: Improve ordering and titles in API TOCs Oct 18, 2022
@wbpcode
Copy link
Copy Markdown
Member

wbpcode commented Oct 18, 2022

Seems like related to #22875. will we get this in 1.24.0?

@wbpcode
Copy link
Copy Markdown
Member

wbpcode commented Oct 18, 2022

/retest

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Oct 18, 2022

will we get this in 1.24.0?

im hoping so - im working on it now

@repokitteh-read-only
Copy link
Copy Markdown

Retrying Azure Pipelines:
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #23536 (comment) was created by @wbpcode.

see: more, trace.

@wbpcode
Copy link
Copy Markdown
Member

wbpcode commented Oct 18, 2022

will we get this in 1.24.0?

im hoping so - im working on it now

Thanks for your hard work.

phlax added 2 commits October 18, 2022 13:38
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax changed the title [WIP] docs: Improve ordering and titles in API TOCs docs: Improve ordering and titles in API TOCs Oct 18, 2022
@phlax phlax marked this pull request as ready for review October 18, 2022 13:10
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Oct 18, 2022

cc @mattklein123 i have focused on this page (and related):

https://storage.googleapis.com/envoy-pr/53aca79/docs/api-v3/api.html

as it seemed the worst offender in terms of readability.

alpha ordering can be imperfect as it doesnt always group as you want - i have done a bit of tweaking of api titles to try and improve this - we could probably go further - eg Path matcher -> Matcher - path, String matcher -> Matcher - string etc

i have also tried to make the titles more consistent in terms of capitalization

@phlax phlax added this to the 1.24.0 milestone Oct 18, 2022
Copy link
Copy Markdown
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

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

Nice!

@phlax phlax merged commit 355f9ea into envoyproxy:main Oct 18, 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.

Use alphabetic ordering for tocs in API docs

4 participants