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

api: Removed duplicate links. #15307

Merged
merged 2 commits into from
Mar 5, 2021
Merged

api: Removed duplicate links. #15307

merged 2 commits into from
Mar 5, 2021

Conversation

mk46
Copy link
Contributor

@mk46 mk46 commented Mar 4, 2021

Signed-off-by: Manish Kumar manish.kumar1@india.nec.com

Commit Message: Removed duplicate links from extensions/categories.
Additional Description: Removed duplicate links from extensions/categories.
Risk Level:
Testing: Format
Docs Changes:
Release Notes:
Platform Specific Features:
Fixes #15191

Signed-off-by: Manish Kumar <manish.kumar1@india.nec.com>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/envoy/.
API shepherd assignee is @htuch
CC @envoyproxy/api-watchers: FYI only for changes made to api/envoy/.

🐱

Caused by: #15307 was opened by mk46.

see: more, trace.

@mk46
Copy link
Contributor Author

mk46 commented Mar 4, 2021

CC@phlax

@phlax
Copy link
Member

phlax commented Mar 4, 2021

redirect to current docs build

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

@phlax
Copy link
Member

phlax commented Mar 4, 2021

so im looking at the docs overall and wondering how we can make it a bit clearer - i think if you didnt understand the typed_config etc already it would be quite confusing

heres a screenshot of how it looks to me now:

access_log-typed_config

@phlax
Copy link
Member

phlax commented Mar 4, 2021

worth mentioning - the next part of the plan is to add some example configs into the tip box - so we should probably bear that in mind as we update...

@phlax
Copy link
Member

phlax commented Mar 4, 2021

for the name im thinking maybe change the text to something like:

The name of the access log extension to instantiate.

The name must match one of the compiled in loggers.

See the :ref:`extensions listed in typed_config below <extension_category_envoy.access_loggers>` for the default list of available loggers.

@mk46
Copy link
Contributor Author

mk46 commented Mar 4, 2021

I think we need to also remove the list typed_config because already in the tip box. WDYT?

@phlax
Copy link
Member

phlax commented Mar 4, 2021

yep, for sure was just typing that and trying to think of alternative...

@phlax
Copy link
Member

phlax commented Mar 4, 2021

perhaps, something like

Custom configuration that must be set according to the access logger extension being instantiated

@phlax
Copy link
Member

phlax commented Mar 4, 2021

one thing im noticing is that the links to the extensions link to the link back rather than the extension itself (hope this makes sense!)

wondering how we can improve that

Signed-off-by: Manish Kumar <manish.kumar1@india.nec.com>
@mk46
Copy link
Contributor Author

mk46 commented Mar 4, 2021

/retest

@repokitteh-read-only
Copy link

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

🐱

Caused by: a #15307 (comment) was created by @mk46.

see: more, trace.

@phlax
Copy link
Member

phlax commented Mar 4, 2021

@mk46 main is failing atm - once #15310 has landed merging main should fix tests

@mk46
Copy link
Contributor Author

mk46 commented Mar 5, 2021

/retest

@repokitteh-read-only
Copy link

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

🐱

Caused by: a #15307 (comment) was created by @mk46.

see: more, trace.

@htuch
Copy link
Member

htuch commented Mar 5, 2021

Thanks @mk46. I agree with @phlax that we should make sure that the docs read cleanly, probably just some lightweight rewording can be done so that they make sense in conjunction with the new extension linkages.

@phlax can you let me know when this looks good to you?

@phlax phlax mentioned this pull request Mar 5, 2021
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

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

@mk46 thanks for this

i think there is quite a bit of further work to do with the docs <> extensions etc

i created a pr to generate docs and check through here:

https://storage.googleapis.com/envoy-pr/75068a5/docs/search.html?q=EXTENSION_CATEGORY_TRACER&check_keywords=yes&area=default

but in terms of the scope of this PR all of the duplicate category information is cleared up, so lgtm

thanks

@phlax
Copy link
Member

phlax commented Mar 5, 2021

@htuch lgtm

Copy link
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!

@repokitteh-read-only repokitteh-read-only bot removed the api label Mar 5, 2021
@mattklein123 mattklein123 merged commit a1cff0e into envoyproxy:main Mar 5, 2021
@mk46 mk46 deleted the rm_dups branch March 12, 2021 11:55
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.

Remove duplicated links to extensions/categories
4 participants