Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add info about Gitpod #687

Merged
merged 4 commits into from
Oct 5, 2020
Merged

[DOC] Add info about Gitpod #687

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae696d4
[DOC] Add info about Gitpod
Oct 1, 2020
5cf00dd
Update docs/development/ide-configuration.md
aibcmars Oct 2, 2020
f2b23f3
Apply suggestions from code review
aibcmars Oct 5, 2020
43fbaf2
Merge branch 'master' into doc-add_gitpod_ide_information
csouchet Oct 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion docs/development/ide-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,33 @@ To fully benefit the ESLint and Jest testing frameworks, you must properly set u
This document describes how to directly integrate in your IDE some tools the npm build is relying on. For the IDE not
mentioned here, the following should help you to know which extensions or plugins to add to your development environment.

* [Gitpod](#Gitpod)
* [Visual Studio Code](#visual-studio-code)
* [IntelliJ](#intellij)


### Gitpod

It is advised to read the information written below.
If you are however familiar with Gitpod, you can jump there and start coding right away by one click: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/process-analytics/bpmn-visualization-js)

#### Git integration

The best way to learn is to read official [Gitpod doc git](https://www.gitpod.io/docs/git/).

You can easily create Pull Requests directly from Gitpod [Gitpod doc pull requests](https://www.gitpod.io/docs/pull-requests/).

Once you have logged into Gitpod, do not forget to give it access to write in public repositories:

1. Visit: [https://gitpod.io/access-control/](https://gitpod.io/access-control/)
2. Check the box titled: **Write public repos**
3. Click on **Update** button

After that quick setup, you are able to contribute.

When Gitpod IDE is started, the `npm install` command is launched automatically. The workspace is ready to build and run dev server and tests.


### Visual Studio Code

#### [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
Expand Down Expand Up @@ -97,4 +120,3 @@ It helps to avoid coding mistakes -> reduced technical debt
We use [asciidoc](https://asciidoctor.org/docs/what-is-asciidoc/) to write the documentation.

An [AsciiDoc IntelliJ Plugin](https://plugins.jetbrains.com/plugin/7391-asciidoc) is a helpful plugin that permits visualizing .adoc files directly in IntelliJ