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

Help Wanted: Add Gitpod docs link to server repo's README #1243

Closed
mickmister opened this issue May 4, 2023 · 8 comments · Fixed by mattermost/mattermost#25057
Closed

Help Wanted: Add Gitpod docs link to server repo's README #1243

mickmister opened this issue May 4, 2023 · 8 comments · Fixed by mattermost/mattermost#25057
Assignees

Comments

@mickmister
Copy link
Contributor

mickmister commented May 4, 2023

https://developers.mattermost.com/contribute/more-info/getting-started/using-gitpod

The typical usage of Gitpod is to have an entrypoint in the README of a project. We have docs made to link to in the server repo, but we haven't added the link there.

There are a few options for presentation. Using links or certain images:

[Contribute with Gitpod](https://gitpod.io/#https://github.com/mattermost/mattermost-server)

[![Small Image](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/mattermost/mattermost-server)

[![Large Image](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/mattermost/mattermost-server)

Which renders as:

Contribute with Gitpod

Small Image

Large Image


Some additional related items:

@mickmister
Copy link
Contributor Author

cc @azigler for visibility

@mickmister
Copy link
Contributor Author

Also cc @cwarnermm @justinegeffen 🙂

@justinegeffen
Copy link
Contributor

Thanks, @mickmister! What is the turnaround required for this?

@mickmister
Copy link
Contributor Author

@justinegeffen No urgency at all on this. Technically doesn't ever need to be done but I want to capitalize on the efforts we have for documenting how to use Gitpod. Also, I'd say discussion of how this should be done is the first step. Where in the README and what to use as presentation as mentioned in the ticket description.

@mickmister
Copy link
Contributor Author

@cwarnermm I'm wondering your thoughts on this ticket, particularly what rendering style mentioned in the description we should use

@cwarnermm
Copy link
Member

@mickmister - The second option provided feels like a good fit, particular when contrasted to our own plugin README pages:

Small Image

Do you have bandwidth to make these updates, @mickmister?

@mickmister mickmister self-assigned this Sep 15, 2023
@cwarnermm cwarnermm changed the title Add Gitpod docs link to server repo's README Help Wanted: Add Gitpod docs link to server repo's README Sep 29, 2023
@aniketh-varma
Copy link
Contributor

Hi @cwarnermm, I would like to work on this issue.

@mickmister
Copy link
Contributor Author

Awesome! Thanks @aniketh-varma!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants