[Doc][Plugin] Improve visibility of Custom plugin docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the main documentation and community page referenced in the screenshots, then locate the current Custom plugin and Making Contributions sections. Confirm that the custom plugin guidance is easier to find, the requested heading is updated, and the contribution page links to it; verify the rendered pages before considering the documentation change complete.
Written by the indexing model from the issue text.
Description
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"
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.
- Dominant language
- TypeScript
- Stars
- 44
- Forks
- 116
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/devlake-website
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
apache/devlake-website#41 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
apache/devlake-website#823 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
apache/devlake-website#819 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
apache/devlake-website#812 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
apache/devlake-website#811 ·
All issues in apache/devlake-website
Similar issues
-
check:passed streams:add
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Fission-AI/OpenSpec#1986 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nestjs/docs.nestjs.com#3554 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
publicodes/publicodes#868 ·
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 78/100
EclipseFdn/open-vsx.org#13488 ·
Maintainers usually reply within 2 days