From d31d21d89ec5397fbc4a24b27930c3282788ae4b Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Thu, 7 May 2020 21:39:34 +0000 Subject: [PATCH 1/2] Revert "gitpod: remove from docs contrib guide for now" This reverts commit 87906e25832197da18f700be49e1a6d0885b7e7d. --- content/docs/user-guide/contributing/docs.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/content/docs/user-guide/contributing/docs.md b/content/docs/user-guide/contributing/docs.md index 92d401ab5b..4ee32e973e 100644 --- a/content/docs/user-guide/contributing/docs.md +++ b/content/docs/user-guide/contributing/docs.md @@ -53,11 +53,19 @@ We will review your PR as soon as possible. Thank you for contributing! ## Development environment -We highly recommend running this web app locally 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 +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. +> +> +> Open in Gitpod +> + Make sure you have a recent LTS version of [Node.js](https://nodejs.org/en/) (`>=12.0.0`), and install [Yarn](https://yarnpkg.com/): From 75f025616558d423daf2b9010cf492e98ff56dab Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Thu, 7 May 2020 21:49:36 +0000 Subject: [PATCH 2/2] [docs] add documentation on how to make a Pr with Gitpod. --- content/docs/user-guide/contributing/docs.md | 26 ++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/content/docs/user-guide/contributing/docs.md b/content/docs/user-guide/contributing/docs.md index 4ee32e973e..6db7957903 100644 --- a/content/docs/user-guide/contributing/docs.md +++ b/content/docs/user-guide/contributing/docs.md @@ -66,6 +66,32 @@ formatted and linted as well, which is also ensured by the full setup below. > Open in Gitpod > +
+ +### 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: + + ![image](https://user-images.githubusercontent.com/46004116/76392493-75727880-6393-11ea-8939-41e6c36477de.png) + +- 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: + + ![image](https://user-images.githubusercontent.com/46004116/76298550-6fb95c00-62db-11ea-9fda-f4e8c0840e69.png) + +- 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: + + ![image](https://user-images.githubusercontent.com/46004116/76299985-c9228a80-62dd-11ea-930c-00eb22156c9e.png) + +- 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: + + ![image](https://user-images.githubusercontent.com/46004116/76300458-9036e580-62de-11ea-8f24-ebaa664204ce.png) + +
+ Make sure you have a recent LTS version of [Node.js](https://nodejs.org/en/) (`>=12.0.0`), and install [Yarn](https://yarnpkg.com/):