You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/07/14 05:45:04 UTC
[GitHub] [apisix] spacewander commented on pull request #7451: docs: improve OpenTelemetry documentation
spacewander commented on PR #7451:
URL: https://github.com/apache/apisix/pull/7451#issuecomment-1184015475
> > We should discuss the structure of this type of document. Maybe we can put Load Plugin and Plugin YAML Attributes under "Related Configuration".
>
> Please consider this a Template Update PR, and I take the `opentelemetry` documentation as an example. For this kind of plugin (needs multiple configurations), this PR's structure:
>
> 1. Description
>
> 2. Load Plugin
>
> 3. Plugin YAML Attributes (optional)
>
> 4. Plugin Attributes
>
> 5. Enable Plugin
>
> 6. Disable Plugin
>
>
> This structure's flow is the same as real use cases, but if you move Step 2 and Step 3 to another place, it breaks the use flow IMO. cc @navendu-pottekkat @spacewander @membphis
The template looks good to me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org