serverless / serverless/serverless
Seclude non AWS providers documentation into its plugin repositories
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 46.9k
- Forks
- 5.7k
- Avg merge
- 10h 7m
- Merged PRs (30d)
- 57
Description
Use case description
Providers documentation should be maintained together with its implementation.
Proposed solution
Aside of moving the document files, it'll require adjustments in https://github.com/serverless/site/ which should read provider documentation from its plugin repository, and eventually regeneration should be automatically triggered by changes in plugin (similarly as we rebuild the site when changes to master are pushed here)
Contributor guide
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.
Research direction
Start by locating the non-AWS provider documentation files in this repository and reviewing how serverless/site currently consumes provider documentation. Trace the existing site regeneration triggered by master changes, then confirm the scope needed for plugin repositories. Done means the documents are maintained with their implementations, the site reads them from plugin repositories, and plugin changes trigger regeneration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100