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

[Doc][Plugin] Improve visibility of Custom plugin docs #650

Open
ghost opened this issue Sep 27, 2023 · 2 comments
Open

[Doc][Plugin] Improve visibility of Custom plugin docs #650

ghost opened this issue Sep 27, 2023 · 2 comments
Labels
type/documentation Improvements or additions to documentation

Comments

@ghost
Copy link

ghost commented Sep 27, 2023

Documentation Scope

This can improve the custom plugin visibility in main docs and community page

Describe the Change

Please check screenshots below

Screenshots

  • The Custom plugin docs can be separated from plugins section for more visibility
  • The Titile "Customize" can be renamed to "Implement a custom plugin"
image - The above custom plugin implementation can additionally be linked to "Making Contributions" image

Additional context

There has been multiple instances where developers asked the question in the community on how to find the docs for testing custom plugins, finding resources etc.

@ghost ghost added the type/documentation Improvements or additions to documentation label Sep 27, 2023
@d4x1
Copy link
Contributor

d4x1 commented Oct 7, 2023

I think this advice is reasonable.
cc @Startrekzky @klesh

@Startrekzky
Copy link
Contributor

Hi @JoshuaPoddoku The customize doc actually describes how to use the customize plugin rather than implement the plugin, that's why we put it under the "Plugin" folder. To increase the discoverability of this doc, I added an entry in the domain layer model doc. https://devlake.apache.org/docs/DataModels/DevLakeDomainLayerSchema#how-to-customize-data-models
image

If you want to further increase the visibility of the doc, instead of moving the doc's path, can you think of other ways to achieve this? For example, add a doc to the "Configuration" folder with the name "How to add customize data schema?" and link it to the doc, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants