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

docs: Add Plugin Metadata in Terminology #9261

Closed
kayx23 opened this issue Apr 7, 2023 · 4 comments · Fixed by #10702
Closed

docs: Add Plugin Metadata in Terminology #9261

kayx23 opened this issue Apr 7, 2023 · 4 comments · Fixed by #10702
Assignees
Labels
doc Documentation things good first issue Good for newcomers

Comments

@kayx23
Copy link
Member

kayx23 commented Apr 7, 2023

Current State

Plugin metadata doesn't have an associated doc under Terminology

image

Desired State

Perhaps plugin metadata should have its own doc in terminology too?

@kayx23 kayx23 added the doc Documentation things label Apr 7, 2023
@pottekkat
Copy link
Member

We can, but IMO, we don't need it because we mention the metadata available for each Plugin in the corresponding Plugin docs. Metadata doesn't have a different meaning here.

Plugin Config needs to have a section here because it is a concept specific to APISIX.

If more people find that this is missing in the docs, we can add it.

@kayx23
Copy link
Member Author

kayx23 commented May 17, 2023

Here I was referring to the metadata object one can create with the admin API. It has a "global" effect on plugin instances of the same name.

Metadata properties set at the plugin level is more granular and has a higher priority over the "global" metadata object. I don't know where this concept was explained in the current doc.

This was before this doc was written https://docs.api7.ai/apisix/key-concepts/plugin-metadata

@pottekkat
Copy link
Member

@kayx23 Thanks for clearing that. Makes sense to add it.

@kayx23 kayx23 added the good first issue Good for newcomers label Dec 22, 2023
@smileby
Copy link
Contributor

smileby commented Dec 24, 2023

@pottekkat @kayx23
Hi, I have made additions to the document and submitted a pull request. Could you please review it to see if there are any issues? Thank you very much.

Add Plugin Metadata in Terminology #10702

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants