From 1b6690a6d7f35a5603290664462bc14ed4166f44 Mon Sep 17 00:00:00 2001 From: Jan Koehnlein Date: Mon, 3 May 2021 11:42:10 +0000 Subject: [PATCH] added Gitpod config Signed-off-by: Jan Koehnlein --- .gitpod.yml | 18 ++++++++++++++++++ README.md | 5 +++++ 2 files changed, 23 insertions(+) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..b5d55ef34 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,18 @@ +ports: + - port: 3000 + visibility: public + onOpen: open-preview +tasks: + - before: cd website + init: npm install + command: npm start +github: + prebuilds: + master: true + branches: true + pullRequests: true + pullRequestsFromForks: false + addCheck: true + addComment: true + addBadge: false + addLabel: false diff --git a/README.md b/README.md index 165cbabb3..ce972da13 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,16 @@ [![Commit Activity (Year)](https://img.shields.io/github/commit-activity/y/openebs/openebs-docs.svg?style=flat-square)](https://github.com/openebs/openebs-docs/commits) [![Contributors](https://img.shields.io/github/contributors/openebs/openebs-docs.svg?style=flat-square)](https://github.com/openebs/openebs-docs/graphs/contributors) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fopenebs%2Fopenebs-docs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fopenebs%2Fopenebs-docs?ref=badge_shield) +[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/openebs/openebs-docs) openebs-docs is the repository for the official OpenEBS documentation. This is using Docusaurus as a documentation framework. It's easy to use and write documentation using Docusaurus, which uses markdown markup language. Additional details on the Docusaurus project can be found [here](https://docusaurus.io/docs/en/installation.html). ## For Developers +Instead of performing the following steps, you might just want to edit the docs in a fully pre-configured development environment +in the browser: [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://github.com/openebs/openebs-docs). + ### Install Node.js ```bash @@ -67,3 +71,4 @@ The following procedure lists the tasks from the time you select an issue to pub The project is licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for the full license text. [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fopenebs%2Fopenebs-docs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fopenebs%2Fopenebs-docs?ref=badge_large) +