[docs] add documentation on how to make a Pr with Gitpod. #1262
Conversation
|
|
||
| <details> | ||
|
|
||
| ### How to make a Pull Request with Gitpod? |
There was a problem hiding this comment.
@jorgeorpinel @nisarhassan12 feels it's not a good place for very long instructions like this in this doc, sorry. It's a good thing to mention that there is a possibility, may be provide the button, but docs like this should be maintained but the Gitpod, not us.
There was a problem hiding this comment.
@shcheklein I agree. Making Prs with Gitpod is briefly documented here https://www.gitpod.io/docs/pull-requests/ should I update the Pr to only have the link instead ?
There was a problem hiding this comment.
@nisarhassan12 I'll let @jorgeorpinel decide on this :)
There was a problem hiding this comment.
Hmm I thought the expandable section would be appropriate for this (I would just put it inside the block quote). But indeed we shouldn't have to maintain Gitpod instructions that may change in the future... Sorry, I guess I didn't think it through. Let me think... ⏳
There was a problem hiding this comment.
I guess we could just link to https://www.gitpod.io/docs/git/ and https://www.gitpod.io/docs/pull-requests/ but the forking part is not mentioned anywhere unfortunately, which is my main concern.
We cold also have a separate user-guide like we have on some 3rd party tools e.g. https://dvc.org/doc/user-guide/setup-google-drive-remote or https://dvc.org/doc/user-guide/running-dvc-on-windows
I supose it'll be easier for me to take over this PR. Thanks for your contributions so far Nisar! (I hope you enabled repo maintainers to push to the PR branch 🙂)
There was a problem hiding this comment.
p.s. please notice my feature request in your repo @nisarhassan12 thanks: gitpod-io/gitpod/issues/1482
There was a problem hiding this comment.
p.s. please notice my feature request in your repo @nisarhassan12 thanks: gitpod-io/gitpod/issues/1482
@jorgeorpinel I'm not sure about this I think I have not unchecked the following while making the PR:
Please let me know if you are not able to push to my branch.
| - Fork the repo by selecting Find Command from View in the top menu and then | ||
| type fork and press enter: | ||
|
|
||
|  |
There was a problem hiding this comment.
We should host these images on the dvc.org (e.g. to process them properly with sharp)? not sure what are the consequences of sharing it like this. Btw, @nisarhassan12 how did you create them?
There was a problem hiding this comment.
I think he pasted them into a Github issue or comment like this:
There was a problem hiding this comment.
Which is interesting. I wonder it Github ever deletes images from it's CDN.
There was a problem hiding this comment.
yeah! True I pasted them in Github comment. Sorry, this is a bad idea.
|
@nisarhassan12 @jorgeorpinel any updates on this one? |
@shcheklein Thanks. @jorgeorpinel said the above ☝️ in #1262 (comment) |
|
@nisarhassan12 I see, got it. Thanks. |
|
Yes, I still have this under my radar! |
|
Closing this for now. After a few discussions with the team I think we should keep the docs more or less general, and avoid providing external links unless they provide some different flow, bring substantially different, faster, etc. experience. Some thoughts behind this logic. In our case we have two types of ad-hoc contributors:
Also, we def should avoid using Github URLs for assets, or complicated instructions. |
|
Understood. I do like Gitpod as well as https://github.com/features/codespaces (I also used to work with https://aws.amazon.com/cloud9/ some years ago, not sure if they now integrate with GH as wlel) but not sure whether we should mention them somewhere or how. Maybe in the README.md ... Will think about it. |
Closes #1253