Skip to content

Commit 5c48da9

Browse files
Addison Schultzgitbook-bot
authored andcommitted
GitBook: No commit message
1 parent 3798ced commit 5c48da9

File tree

3 files changed

+8
-14
lines changed

3 files changed

+8
-14
lines changed

docs/getting-started/development.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ By default (defined in the CLI-generated `gitbook-manifest.yaml`), your integrat
2121

2222
After publishing your integration, the CLI will give you a link to install your integration into the organization you’ve set.
2323

24-
You need to install your app into at least 1 space or organization in order to develop it locally. Make sure to note the `spaceId` of the space you're installing it into for step 2.
24+
You need to install your app into at least 1 space or organization in order to develop it locally. 
2525
{% endstep %}
2626

2727
{% step %}
@@ -30,17 +30,15 @@ You need to install your app into at least 1 space or organization in order to d
3030
While inside the root directory of your app, run:
3131

3232
```
33-
gitbook dev <spaceId>
33+
gitbook dev
3434
```
3535

36-
This will start a development server tied to the space specified in the command.
37-
38-
After running the command, the CLI will generate a `gitbook-dev.yaml` file that contains the `spaceId` needed to establish the connection while you continue to develop your app. You can change this at any time in by re-running `gitbook dev <spaceId>`.
36+
This will start a development server tied to your organization.
3937

4038
{% hint style="info" %}
4139
Running this command will start a development server for use by the integration only. **You do not need to navigate to the port the server is running on.** \
4240
\
43-
All integration traffic to the specified space will automatically be served from your local server instead of the published version.
41+
All integration traffic will automatically be served from your local server instead of the published version.
4442
{% endhint %}
4543
{% endstep %}
4644

docs/getting-started/setup-guide.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,14 @@ In order to develop your integration on your local machine, you’ll first need
6262
gitbook publish
6363
```
6464

65-
This will publish your app to GitBook, and return a link with which you can install your integration. Install your integration into a space, and note the `spaceId` in the URL.
65+
This will publish your app to GitBook, and return a link with which you can install your integration. After installing your integration into your organization, space, or site, you can then run the development command to work on your integration locally.
6666

6767
Return to your integration on your local machine, and in the root of the integration, run the following development command:
6868

6969
```bash
70-
gitbook dev spaceId
70+
gitbook dev
7171
```
7272

73-
{% hint style="info" %}
74-
Example: If your integration is installed in a space [`https://app.gitbook.com/o/1234/s/5678/`](https://app.gitbook.com/s/yPzlUas0Q5RLUIZ0s3Cl/integrations/development-environment), your `spaceId` would be `5678`.
75-
{% endhint %}
76-
7773
After running the development script, you’re ready to start building your integration! Any changes made in your local version of the integration will be sent to the space you have your integration installed in. You’ll also be able to see logs in your console where applicable.
7874

7975
Read more on development and publishing concepts:

docs/integrations/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ The token can also be provided using the command line argument `--token=<token>`
2020

2121
Create and initialize a new integration locally. The program will prompt for information about the integration.
2222

23-
### `gitbook dev <spaceId>`
23+
### `gitbook dev`
2424

25-
Create a live connection with a space within your GitBook organization. Updates made locally while the connection is running will automatically be received in the chosen space.&#x20;
25+
Create a live connection from your integration to your GitBook editor. Updates made locally while the connection is running will automatically be received in the editor.&#x20;
2626

2727
See the [development section](../getting-started/development.md) to learn more.
2828

0 commit comments

Comments
 (0)