Documentation for strapi plugins repository - ReadMe.md
@em-abee is already working on this.
Since Mar 8, 2024.
Assessment
This issue has not been assessed yet.
Description
Description
Strapi-plugins repository is missing documentation. Please create proper documentation for the repository that includes the below details.
- Project Title and Description: Clearly state the project name and provide a concise description of its purpose and functionalities.
- Table of Contents (Optional): Include a table of contents if we have multiple sections.
- Installation Instructions: Detail the steps required to set up and run the project, including any dependencies and system requirements. Add screenshots/videos of installation and usage.
- Usage Instructions: Explain how to use the project, including basic commands, functionalities, and relevant examples.
- License: Please use the license file used here.
- Details about all the plugins and what is the use ?
Please follow the structure here
Goals
- Repository must have a proper documentation
- .
Expected Outcome
A readme file (documentation) that has all the relevant details provided in the description section.
Acceptance Criteria
- Properly structure readme file with all the required details.
Implementation Details
NA
Mockups / Wireframes
NA
[Please note that the below section of the ticket has to be in the format as mentioned as it is key to enabling proper listing of the project. Please only choose the options mentioned under the headings wherever applicable.]
Product Name
strapi-plugins
Project Name
strapi-plugins
Tech Skills Needed:
strapi-plugin repo knowledge
Documentation
Complexity
Low
Category
Documentation
Sub Category
Documentation
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
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 beckn/strapi-plugins
-
Migrated MySQL Unified-Strapi-Dev Database to Unified-Strapi-StagingMay be free again @em-tpt-bbandi claimed this 630 days ago, and no pull request is open. Openstrapi-plugins
beckn/strapi-plugins#227 · 1 comment · 1 assignee ·
-
Deployed Unified-Strapi-Staging on Bpp-Unified-Staging Machine with DNS Entry and Nginx ConfigurationMay be free again @em-tpt-bbandi claimed this 630 days ago, and no pull request is open. Openstrapi-plugins
beckn/strapi-plugins#226 · 1 comment · 1 assignee ·
-
bug QA
beckn/strapi-plugins#194 · 4 comments · 1 assignee ·
-
Merging consumer & prosumer flow : Code changes & Install Unified plugin in the new strapiMay be free again @em-abee claimed this 678 days ago, and no pull request is open. Open
beckn/strapi-plugins#193 · 1 comment · 1 assignee ·
-
Merging consumer & prosumer flow : Import tables and their corresponding schema files of BPP and BAP in the new strapiMay be free again @em-abee claimed this 678 days ago, and no pull request is open. Open
beckn/strapi-plugins#192 · 1 comment · 1 assignee ·
All issues in beckn/strapi-plugins
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/vscode-livepreview#876 ·
Maintainers usually reply within 1 day
-
needs-triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
JustJarethB/invoicer#54 ·
-
ICP 1.2.0 shows a scheduled task's interval in milliseconds under the label "Interval (In seconds)"OpenNeeds Triage Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
wso2/product-integrator#2585 ·
Maintainers usually reply within 1 day
-
check:passed streams:add
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
design
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MTES-MCT/monitor-field#119 ·
Maintainers usually reply within 1 day