Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .changeset/forty-doodles-ring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'@gitbook/integration-github-copilot': patch
'@gitbook/integration-segment': patch
'@gitbook/integration-github': patch
'@gitbook/integration-gitlab': patch
'@gitbook/integration-runkit': patch
'@gitbook/integration-slack': patch
---

Update documentation links
8 changes: 4 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ We recommend adding as many relevant links, minimal reproductions of the issue,
If you're interested in solving an issue in our repository, start by scanning through it's exisiting issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix. See the following sections below for more information on contributing for specific sections.

### Docs
The official developer docs for GitBook, hosted on https://developer.gitbook.com/. Our documentation uses one of GitBook's most useful features-[Git Sync](https://docs.gitbook.com/product-tour/git-sync)!
The official developer docs for GitBook, hosted on https://developer.gitbook.com/. Our documentation uses one of GitBook's most useful features-[Git Sync](https://gitbook.com/docs/product-tour/git-sync)!

Git Sync allows you to keep your GitBook site up to date with a remote repository either on GitHub or GitLab. In our case we have the [/docs](../docs/) directory synced with https://developer.gitbook.com/. This means that any changes reviewed, approved, and merged into this directory will automatically be deployed!

Expand All @@ -39,9 +39,9 @@ If you're interested in contributing to any of our already published integration
### Packages
You're also welcome to contribute updates or improvements to the packages living in [/packages](../packages/). Head to each package's documentation page to learn more about what each one does.

`@gitbook/cli`: https://developer.gitbook.com/cli/quickstart
`@gitbook/api`: https://developer.gitbook.com/gitbook-api/librairies/browser-node
`@gitbook/runtime`: https://developer.gitbook.com/integrations/reference
`@gitbook/cli`: https://gitbook.com/docs/developers/integrations/reference
`@gitbook/api`: https://gitbook.com/docs/developers/gitbook-api/overview
`@gitbook/runtime`: https://gitbook.com/docs/developers/integrations/runtime

## Contributing

Expand Down
Binary file added bun.lockb
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/.gitbook/assets/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13406,7 +13406,7 @@ components:
- label
IntegrationContentSecurityPolicy:
description: |
Security policy to validate the content of the integrations scripts and Contentkit. Will be sent as
Security policy to validate the content of the integrations scripts and Contentkit. Will be sent as
headers when processing the script fetch event and the blocks fetch events.
oneOf:
- type: string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Implement Visitor Authentication using Next.js and Clerk

[Visitor Authentication](https://docs.gitbook.com/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook.
[Visitor Authentication](https://gitbook.com/docs/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook.

In order to use Visitor Authentication, you'll need to configure a few tools first—Including setting up a server to handle the sign-in flow your users will go through.

Expand All @@ -9,7 +9,7 @@ This guide explains how you can accomplish the above using [Next.js](https://nex
The rest of this guide follows this [GitHub repository](https://github.com/GitbookIO/va-nextjs-clerk), and will explain the setup and code through the main functionalities of the demo app.

{% hint style="info" %}
This feature is currently accessible to all **Pro and Enterprise** customers. If you are interested in the [Enterprise plan](https://docs.gitbook.com/account-management/plans), please contact [sales@gitbook.com](mailto:sales@gitbook.com) for a quote.
This feature is currently accessible to all **Pro and Enterprise** customers. If you are interested in the [Enterprise plan](https://gitbook.com/docs/account-management/plans), please contact [sales@gitbook.com](mailto:sales@gitbook.com) for a quote.
{% endhint %}

### Clone Example
Expand Down Expand Up @@ -124,7 +124,7 @@ After we sign in successfully, we'll then be able to navigate to our published s

Visitor Authentication allows you to protect published GitBook sites behind a sign-in flow that you control.

Not only is it customizable, but it also opens up the door for many more possibilities in the future around the way you want to work in GitBook. Make sure to head to the [Visitor Authentication](https://docs.gitbook.com/publishing/visitor-authentication) docs to learn more.
Not only is it customizable, but it also opens up the door for many more possibilities in the future around the way you want to work in GitBook. Make sure to head to the [Visitor Authentication](https://gitbook.com/docs/publishing/visitor-authentication) docs to learn more.



Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Implement Visitor Authentication using Node

[Visitor Authentication](https://docs.gitbook.com/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook.
[Visitor Authentication](https://gitbook.com/docs/publishing/visitor-authentication) in GitBook is a powerful way to further control who has access to the information you're publishing. By setting up a custom login screen, you can customize the experience for private materials you might have on GitBook.

In order to use Visitor Authentication, you'll need to configure a few tools first—Including setting up a server to handle the sign-in flow your users will go through.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Let’s dive in!

### Collections

In order to translate your site, you’ll need to have some well-organized content. GitBook provides the perfect solution to structure sites available in multiple languages: [collections](https://docs.gitbook.com/content-creation/content-structure/what-is-a-collection).
In order to translate your site, you’ll need to have some well-organized content. GitBook provides the perfect solution to structure sites available in multiple languages: [collections](https://gitbook.com/docs/content-creation/content-structure/what-is-a-collection).

Collections provide a way to group related spaces together. In the context of i18n, we will use one space for each language, with a space designated to hold the content in the primary language. You can think of this space as your “main” content.

Expand All @@ -30,15 +30,15 @@ After you’ve set up the collection, you can use Git Sync to enable programmati

### GitSync

[GitSync](https://docs.gitbook.com/product-tour/git-sync) is a feature in GitBook that allows you to connect a space to a remote repository hosted on either GitHub or GitLab (_starting to Git the hang of it?_).
[GitSync](https://gitbook.com/docs/product-tour/git-sync) is a feature in GitBook that allows you to connect a space to a remote repository hosted on either GitHub or GitLab (_starting to Git the hang of it?_).

You can check [out our setup video](https://www.youtube.com/watch?v=Fm5hYBsRSXo) to learn more about configuring GitSync in your Space.

{% hint style="warning" %}
**Important:** While your collection will include a space for each language in GitBook, you’ll need to connect each one to your remote repository separately.
{% endhint %}

Use the [Monorepo feature](https://docs.gitbook.com/product-tour/git-sync/monorepos) if you need to configure each space to a specific folder in your remote repository.
Use the [Monorepo feature](https://gitbook.com/docs/product-tour/git-sync/monorepos) if you need to configure each space to a specific folder in your remote repository.

Once you’ve connected your GitBook spaces to a remote repository, we’ll run through how to add workflows on top of your content.

Expand Down Expand Up @@ -73,7 +73,7 @@ jobs:
- uses: actions/checkout@v3
</code></pre>

The example action above will run every time someone merges an update to the `main` branch — which means whenever someone merges a [change request](https://docs.gitbook.com/collaboration/collaboration/change-requests) in GitBook.&#x20;
The example action above will run every time someone merges an update to the `main` branch — which means whenever someone merges a [change request](https://gitbook.com/docs/collaboration/collaboration/change-requests) in GitBook.&#x20;

Because this workflow runs after the content is merged, it will contain up-to-date information about the request, including the latest version of the content.&#x20;

Expand Down
2 changes: 1 addition & 1 deletion integrations/github-copilot/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ previewImages:
- ./assets/gitbook-copilot-preview3.png
externalLinks:
- label: Documentation
url: https://docs.gitbook.com/integrations/github-copilot
url: https://gitbook.com/docs/integrations/github-copilot
categories:
- collaboration
summary: |
Expand Down
2 changes: 1 addition & 1 deletion integrations/github/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ previewImages:
- ./assets/github-sync.png
externalLinks:
- label: Documentation
url: https://docs.gitbook.com/integrations/git-sync
url: https://gitbook.com/docs/integrations/git-sync
categories:
- gitsync
summary: |
Expand Down
6 changes: 3 additions & 3 deletions integrations/github/src/components.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ export const configBlock = createComponent<
space in your repository.{' '}
<link
target={{
url: 'https://docs.gitbook.com/getting-started/git-sync/monorepos',
url: 'https://gitbook.com/docs/getting-started/git-sync/monorepos',
}}
>
Learn More.
Expand All @@ -374,7 +374,7 @@ export const configBlock = createComponent<
from GitBook by a custom template.{' '}
<link
target={{
url: 'https://docs.gitbook.com/getting-started/git-sync/commits',
url: 'https://gitbook.com/docs/getting-started/git-sync/commits',
}}
>
Learn More.
Expand Down Expand Up @@ -456,7 +456,7 @@ export const configBlock = createComponent<
Allow Pull request previews from forked respositories.{' '}
<link
target={{
url: 'https://docs.gitbook.com/integrations/git-sync/github-pull-request-preview#security-considerations',
url: 'https://gitbook.com/docs/integrations/git-sync/github-pull-request-preview#security-considerations',
}}
>
Learn More.
Expand Down
2 changes: 1 addition & 1 deletion integrations/gitlab/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ previewImages:
- ./assets/gitlab-sync.png
externalLinks:
- label: Documentation
url: https://docs.gitbook.com/integrations/git-sync
url: https://gitbook.com/docs/integrations/git-sync
categories:
- gitsync
summary: |
Expand Down
4 changes: 2 additions & 2 deletions integrations/gitlab/src/components.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ export const configBlock = createComponent<
space in your repository.{' '}
<link
target={{
url: 'https://docs.gitbook.com/getting-started/git-sync/monorepos',
url: 'https://gitbook.com/docs/getting-started/git-sync/monorepos',
}}
>
Learn more.
Expand All @@ -357,7 +357,7 @@ export const configBlock = createComponent<
from GitBook by a custom template.{' '}
<link
target={{
url: 'https://docs.gitbook.com/getting-started/git-sync/commits',
url: 'https://gitbook.com/docs/getting-started/git-sync/commits',
}}
>
Learn more.
Expand Down
2 changes: 1 addition & 1 deletion integrations/runkit/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ summary: |

The integration allows you to embed live examples into your GitBook, removing the friction of trying new ideas. You can bring your code to life by allowing your users to run the sample of your code within your documentation.

Adding RunKit notebooks in your documentation is simple - select the RunKit block from the [command palette](https://docs.gitbook.com/tour/editor/blocks#command-palette) and insert your code snippet.
Adding RunKit notebooks in your documentation is simple - select the RunKit block from the [command palette](https://gitbook.com/docs/tour/editor/blocks#command-palette) and insert your code snippet.
Or paste the link to an existing RunKit notebook into the GitBook editor to embed it in your page.

# Configure
Expand Down
8 changes: 4 additions & 4 deletions integrations/segment/tests/events.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { describe, it, expect } from 'bun:test';

import * as api from '@gitbook/api';
import type * as api from '@gitbook/api';

import packageJson from '../package.json';
import { generateSegmentTrackEvent } from '../src/events';
Expand All @@ -20,7 +20,7 @@ const fakeSpaceViewEvent: api.SiteViewEvent = {
fake_cookie: 'cookie',
},
},
url: 'https://docs.gitbook.com/integrations?utm_source=gitbook',
url: 'https://gitbook.com/docs/integrations?utm_source=gitbook',
referrer: 'https://www.gitbook.com/',
};

Expand All @@ -36,9 +36,9 @@ describe('events', () => {
},
page: {
referrer: 'https://www.gitbook.com/',
path: '/integrations',
path: '/docs/integrations',
search: '?utm_source=gitbook',
url: 'https://docs.gitbook.com/integrations?utm_source=gitbook',
url: 'https://gitbook.com/docs/integrations?utm_source=gitbook',
},
userAgent: 'fake-user-agent',
ip: '127.0.0.1',
Expand Down
6 changes: 3 additions & 3 deletions integrations/slack/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ previewImages:
- ./assets/slack-marketplace-3.png
externalLinks:
- label: Documentation
url: https://docs.gitbook.com/integrations/integrations-beta/slack
url: https://gitbook.com/docs/integrations/integrations-beta/slack
- label: Slack App Directory
url: https://slack.com/apps/A7DE1QCTD-gitbook?tab=more_info
visibility: public
Expand All @@ -23,7 +23,7 @@ summary: |
# Overview
With the GitBook Slack integration, your teams have instant access to your documentation, and can get AI-summarized answers about your content.

[Head to our documentation to find out more](https://docs.gitbook.com/integrations/integrations-beta/slack)
[Head to our documentation to find out more](https://gitbook.com/docs/integrations/integrations-beta/slack)

Slack's AI features require GitBook AI, exclusive to Pro/Enterprise plans. Free/Plus users will need to upgrade to Pro to use this integration. Please visit the [pricing page](https://www.gitbook.com/pricing) to learn more.

Expand All @@ -38,7 +38,7 @@ summary: |
To install on a single space, click Integrations in the sub-nav within the GitBook app. Alternatively, you can install it across all your spaces in Settings.
Once you’ve installed it, head over to Slack and authorize the connection. You can select a default channel to post notifications and other messages, but remember — you can summon GitBook in any channel or thread.

[Read our documentation to learn more](https://docs.gitbook.com/integrations/integrations-beta/slack)
[Read our documentation to learn more](https://gitbook.com/docs/integrations/integrations-beta/slack)
configurations:
account:
properties:
Expand Down