mattermost / mattermost/mattermost-developer-documentation
Help Wanted: Emphasize in Gitpod docs how to contribute to a plugin project
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 90
- Forks
- 460
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 2
Description
Our Gitpod configuration tailors the environment for developing with different plugin projects. Using the Gitpod browser extension, navigating to Gitpod from the given plugin repository creates a Gitpod workspace.
We can emphasize this in our docs, possibly in a different page in the docs than the Gitpod docs page. The page is quite long right now. Maybe we can split it up into different pages in the docs.
Some other related items:
- We can add links to all the plugin project READMEs, to create new Gitpod workspaces
- I'd also like to emphasize that you can open a Gitpod workspace from any PR, by using the Gitpod browser extension, and clicking
Open in Gitpodwhile viewing the PR in GitHub
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 with the current Gitpod documentation page and the plugin project READMEs mentioned in the issue. Verify the repository and pull-request workflows using the Gitpod browser extension, then update the documentation so both entry points are explained and all plugin READMEs are linked; split the long page only if needed for clarity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100