Skip to content

Commit 05235a1

Browse files
committed
Moved block to Development Environment Setup
1 parent 52afe3c commit 05235a1

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,6 @@ Use HashiCorp's [Plugin Development](https://www.terraform.io/plugin) guide as a
1010

1111
See the [Developing The Provider](#developing-the-provider) section below for specifics about this GitLab provider.
1212

13-
### GitPod Environment Setup
14-
15-
You can choose to use your own development environment if desired, however a `.gitpod.yml` file is included within the repository to allow the use of [GitPod](https://gitpod.io/) easily.
16-
This will allow you to use GitPod's integration with GitHub to quickly start a web-based development environment including Go and Docker, which are necessary
17-
for running tests. To use GitPod's integration, you have two different options described below. After you've completed one of the two options, your development environment
18-
will be ready within a minute or two. As part of starting up, your development environment will automatically start up the `gitlab-ce` container necessary for running
19-
tests, as described in the "Running Tests/Option 1" section below.
20-
21-
22-
#### Option 1: Manually navigate to GitPod
23-
24-
You can manually sign in and open your workspace within GitPod by following these steps:
25-
26-
1. Navigate to [GitPod](https://gitpod.io/)
27-
1. Click [Login](https://gitpod.io/login/) if you have an account, or [Sign Up](https://www.gitpod.io/#get-started) if you do not.
28-
1. Click on "Continue with GitHub" and authorize GitPod to access your account.
29-
1. After you've signed in, select "Projects" along the top menu, click on your forked `terraform-provider-gitlab` project
30-
1. Hover over either the main branch for your fork or the branch you created for your fork, and click "New Workspace"
31-
32-
#### Option 2: Open your GitPod Workspace directly via URL
33-
34-
1. Navigate to your fork of the `terraform-provider-gitlab` project in GitHub
35-
1. Select the branch you want to develop
36-
1. Add `https://gitpod.io/#` to the front of your URL
37-
38-
Your workspace will automatically open the repository and branch that you selected in GitHub.
39-
4013
## Before Committing
4114

4215
Run `make reviewable` and include any generated files in your commit. This will help ensure your PR passes automated checks.
@@ -87,6 +60,8 @@ Documentation in [/docs](/docs) is auto-generated by [terraform-plugin-docs](htt
8760

8861
## Developing The Provider
8962

63+
### Set Up Your Local Environment
64+
9065
You'll first need [Go](http://www.golang.org) installed on your machine (version 1.16+ is *required*).
9166

9267
1. Clone the git repository.
@@ -102,6 +77,34 @@ You'll first need [Go](http://www.golang.org) installed on your machine (version
10277
$ make build
10378
```
10479

80+
81+
### Use a Remote Environment via GitPod
82+
83+
You can choose to use your own development environment if desired, however a `.gitpod.yml` file is included within the repository to allow the use of [GitPod](https://gitpod.io/) easily.
84+
This will allow you to use GitPod's integration with GitHub to quickly start a web-based development environment including Go and Docker, which are necessary
85+
for running tests. To use GitPod's integration, you have two different options described below. After you've completed one of the two options, your development environment
86+
will be ready within a minute or two. As part of starting up, your development environment will automatically start up the `gitlab-ce` container necessary for running
87+
tests, as described in the "Running Tests/Option 1" section below.
88+
89+
90+
#### Option 1: Manually navigate to GitPod
91+
92+
You can manually sign in and open your workspace within GitPod by following these steps:
93+
94+
1. Navigate to [GitPod](https://gitpod.io/)
95+
1. Click [Login](https://gitpod.io/login/) if you have an account, or [Sign Up](https://www.gitpod.io/#get-started) if you do not.
96+
1. Click on "Continue with GitHub" and authorize GitPod to access your account.
97+
1. After you've signed in, select "Projects" along the top menu, click on your forked `terraform-provider-gitlab` project
98+
1. Hover over either the main branch for your fork or the branch you created for your fork, and click "New Workspace"
99+
100+
#### Option 2: Open your GitPod Workspace directly via URL
101+
102+
1. Navigate to your fork of the `terraform-provider-gitlab` project in GitHub
103+
1. Select the branch you want to develop
104+
1. Add `https://gitpod.io/#` to the front of your URL
105+
106+
Your workspace will automatically open the repository and branch that you selected in GitHub.
107+
105108
### Running Tests
106109

107110
The acceptance tests can run against a Gitlab instance where you have a token with administrator permissions (likely not gitlab.com).

0 commit comments

Comments
 (0)