Skip to content

Commit

Permalink
simplify code contributions by fully automating the dev setup with Gi…
Browse files Browse the repository at this point in the history
…tpod. (#1226)
  • Loading branch information
nisarhassan12 authored May 4, 2020
1 parent e4ec88d commit 6898bb9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
7 changes: 7 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
tasks:
- init: yarn install && yarn build
command: yarn develop

ports:
- port: 8000
onOpen: open-preview
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
13 changes: 10 additions & 3 deletions content/docs/user-guide/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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
Expand Down

0 comments on commit 6898bb9

Please sign in to comment.