[docs] add documentation on how to make a Pr with Gitpod. #1262
+37
−3
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,11 +53,45 @@ We will review your PR as soon as possible. Thank you for contributing! | |
|
|
||
| ## Development environment | ||
|
|
||
| We highly recommend running this web app to check documentation or blog changes | ||
| before submitting them, and it's quite necessary when making changes to the | ||
| website engine itself. Source code and content files need to be properly | ||
| formatted and linted as well, which is also ensured by the full setup below. | ||
|
|
||
| > ⚡ You can create a dev env online using Gitpod (a fully featured online IDE), | ||
| > it'll automatically clone the repo, install the dependencies, and run the app | ||
| > (takes a few minutes), so that you can start straight away. | ||
| > | ||
| > <a href="https://gitpod.io/#https://github.com/iterative/dvc.org"> | ||
| > <img src="https://gitpod.io/button/open-in-gitpod.svg" alt="Open in Gitpod"> | ||
| > </a> | ||
|
|
||
| <details> | ||
|
|
||
| ### How to make a Pull Request with Gitpod? | ||
|
|
||
| - 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. |
||
|
|
||
| - You can commit your changes either using a the `git` cli or using the GUI in | ||
| the top left tab under search as shown below: | ||
|
|
||
|  | ||
|
|
||
| - Once you are done commiting your changes you can push the code via using push | ||
| button from the GitHub tab in the top right corner as shown: | ||
|
|
||
|  | ||
|
|
||
| - Once you have made all the changes and pushed them to your fork. You can make | ||
| PR from the same GitHub tab in top right corner as shown: | ||
|
|
||
|  | ||
|
|
||
| </details> | ||
|
|
||
| Make sure you have a recent LTS version of [Node.js](https://nodejs.org/en/) | ||
| (`>=12.0.0`), and install [Yarn](https://yarnpkg.com/): | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nisarhassan12 I'll let @jorgeorpinel decide on this :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
p.s. please notice my feature request in your repo @nisarhassan12 thanks: gitpod-io/gitpod/issues/1482
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.