From 2619a06076f407a79cd90cabc1be9f037d8cfe4a Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Tue, 17 Mar 2020 21:59:09 +0500 Subject: [PATCH] misc: update Gitpod description (#2421) * update the gitpod setup description to be precise. * add info about Gitpod setup to contributing.md --- CONTRIBUTING.md | 12 ++++++++++++ README.md | 6 ------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f77925be8..3511879e33 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,6 +91,18 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe - For Docusaurus 1 development, run `yarn start:v1` - For Docusaurus 2 development, run `yarn start` +## Online one-click setup for contributing + +You can use Gitpod (a free, online, VS Code-like IDE) for contributing. With a single click it will launch a workspace (for Docusaurus 2) and automatically: + +- clone the docusaurus repo. +- install the dependencies. +- run `yarn run start` + +So that you can start contributing straight away. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/facebook/docusaurus) + ## Pull Requests ### Your First Pull Request diff --git a/README.md b/README.md index 567dcc9244..b8a80c53c8 100644 --- a/README.md +++ b/README.md @@ -44,12 +44,6 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus. -### Contribute online with a single click - -You can use Gitpod (a free, online, VS Code-based IDE) for contributing. It will launch a ready to code workspace (for Docusaurus 2) with all the dependencies installed and the development server running so that you can start contributing straight away. - -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/facebook/docusaurus) - ### Beginner-friendly bugs To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started.