From 6898bb9ea5b0d23aa1def3cbd886a024ed42527c Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Tue, 5 May 2020 04:48:43 +0500 Subject: [PATCH] simplify code contributions by fully automating the dev setup with Gitpod. (#1226) --- .gitpod.yml | 7 +++++++ README.md | 1 + content/docs/user-guide/contributing/docs.md | 13 ++++++++++--- 3 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000000..300827e3ab --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,7 @@ +tasks: + - init: yarn install && yarn build + command: yarn develop + +ports: + - port: 8000 + onOpen: open-preview diff --git a/README.md b/README.md index 61c27fd97d..338216b749 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Maintainability](https://api.codeclimate.com/v1/badges/5872e0a572ec8b74bd8d/maintainability)](https://codeclimate.com/github/iterative/dvc.org/maintainability) [![CircleCI](https://circleci.com/gh/iterative/dvc.org.svg?style=svg)](https://circleci.com/gh/iterative/dvc.org) +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/iterative/dvc.org) [DVC](https://github.com/iterative/dvc) project website's source code. [Documentation](https://dvc.org/doc) and [blog](https://dvc.org/blog) content. diff --git a/content/docs/user-guide/contributing/docs.md b/content/docs/user-guide/contributing/docs.md index 078c0b2219..866b402a5d 100644 --- a/content/docs/user-guide/contributing/docs.md +++ b/content/docs/user-guide/contributing/docs.md @@ -53,9 +53,9 @@ 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. Make sure you have a recent LTS version of [Node.js](https://nodejs.org/en/) @@ -82,6 +82,13 @@ This will start the server on the default port, `8000`. Visit enable the Git pre-commit hook that will be formatting and linting your code and documentation files automatically. +Alternatively you can contribute to dvc.org using Gitpod(a fully featured online +development environment), with a single click it will launch a workspace and +automatically: clone the repo, install the dependencies, run `yarn build` and +start the webserver so that you can start straight away. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) + ### All commands Please, check the project's `package.json` file to see the complete list. For