Skip to content

Commit

Permalink
GITBOOK-546: Update space header docs + images
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Ashby authored and gitbook-bot committed Feb 4, 2025
1 parent 9383127 commit 847c231
Show file tree
Hide file tree
Showing 23 changed files with 1,237 additions and 101 deletions.
221 changes: 221 additions & 0 deletions .gitbook/assets/03_02_25_space_header.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
215 changes: 215 additions & 0 deletions .gitbook/assets/04_02_2025_site_customization.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
210 changes: 210 additions & 0 deletions .gitbook/assets/04_02_25_edit_variant.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
212 changes: 212 additions & 0 deletions .gitbook/assets/04_02_25_page.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
210 changes: 210 additions & 0 deletions .gitbook/assets/04_02_25_reusable_content.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions .gitbook/assets/actions-horizontal - dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions .gitbook/assets/actions-horizontal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions collaboration/change-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ In a change request, you can edit, update and delete elements of your content, r

### Creating a change request

Inside a space where live edits are disabled, click the **Edit in change request** button in the space header to start a new change request.
Inside a space where live edits are disabled, click the **Edit** button in the [space header](../resources/gitbook-ui.md#space-header) to start a new change request.

This will open a new change request, where you can edit or delete content as needed. Your changes are saved automatically, and other people can join you in a change request to collaborate in real-time.

Once you’re happy with your changes, you can use the button in the header bar to **Request a review** of your change request, or **Merge** it directly into the main branch.

### Preview a change request

You can preview the changes you've made in a change request through the preview button in the upper right corner. This will open up a window with your docs and the proposed changes in a staging environment, so you and your team can see your changes in the entire context of your published documentation.
You can preview the changes you've made in a change request through the preview button in the [space header](../resources/gitbook-ui.md#space-header). This will switch you to a view with your docs and the proposed changes in a preview window, so you can see your changes in the entire context of your published documentation.

{% hint style="info" %}
You can only preview change requests for spaces added to a [published docs site](../publishing-documentation/publish-a-docs-site/).
Expand All @@ -37,7 +37,7 @@ Request a review on your change request when you want to ask members of your tea

You can add a description to your change request to give your reviewers some context, and tag specific people that you want to check your work.

When you click **Request review**, the change request’s status will change to **In review**, and anyone you tagged in your review request will get a notification.
When you click **Request a review**, the change request’s status will change to **In review**, and anyone you tagged in your review request will get a notification.

If your changes don’t require a review, you can merge your changes into the main version directly instead.

Expand All @@ -53,14 +53,14 @@ Most reviews will take place in the change request’s [comments](comments.md),

#### Diff view <a href="#diff-mode" id="diff-mode"></a>

Diff view allows you to toggle a view that makes it easy to see what’s been edited in a change request. It will highlight any edited pages in the space, and on the pages it will show the specific blocks that have been added, edited or removed.
When you open the **Changes** tab in the space header, the diff view will appear. Diff view highlights every page and block that’s been edited in a change request. It will highlight any edited pages in the table of contents, and on the pages it will show the specific blocks that have been added, edited or removed.

There are two options for using diff view:
There are two options when using diff view:

1. **All pages** - this is the default mode for diff view, which will show both modified and non-modified pages in the table of contents. This is good for seeing which pages have been edited in the context of the entire space.
2. **Only changes** - this mode will show only the modified pages in the table of contents, which helps you focus on the changed content. This is particularly helpful in larger spaces with many pages and sub-pages.
1. **Show all pages** – This is the default mode for diff view, which will show both modified and non-modified pages in the table of contents. This is good for seeing which pages have been edited in the context of the entire space.
2. **Show only changed pages** – This mode will show only the modified pages in the table of contents, which helps you focus on the changed content. This is particularly helpful in larger spaces with many pages and sub-pages.

You can toggle diff view on or off in any change request.
You can switch to the **Changes** tab to check the diff view in any change request.

### Merging a change request

Expand Down Expand Up @@ -94,4 +94,4 @@ If you don’t want to choose between versions, you can resolve a merge conflict

If you decide not to merge a change request and want to remove it from the queue, you can archive it.

To archive a change request, first open it up. Then click the **Actions menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> in the top-right corner of the window and choose **Archive**. You can find and reopen archived change requests later by opening the **Change Requests** menu and selecting the **Archived** tab.
To archive a change request, first open it up. Then click the **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> next to the change request’s title and choose **Archive**. You can find and reopen archived change requests later by opening the **Change Requests** menu and selecting the **Archived** tab.
6 changes: 4 additions & 2 deletions collaboration/live-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ GitBook supports live collaboration, meaning you’ll be able to work on the sam

### Toggling live edit mode

You can toggle live edit mode in a space by selecting **Lock live edits** or **Unlock live edits** from the space’s **Action menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture>.
You can toggle live edit mode in a space by selecting **Lock live edits** or **Unlock live edits** from the [space header’s](../resources/gitbook-ui.md#space-header) **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture>.&#x20;

When a space is in **Live edits** mode, the space header will show the **Editor** tab. When it is in **Locked live edits** mode, the space header will show a **Read-only** tab. When the Read-only tab appears in the space header, you will need to open a change request to edit the content of the page.

### When is live editing _not_ available?

You cannot unlock live editing if:

1. a space is published with the **In collection**, **Public**, or **Unlisted** visibility option. We know this is a limitation, and we hope to change this in the future.
1. a space is published with the **In collection**, **Public**, or **Unlisted** visibility option.
2. a space has [GitHub or GitLab Sync](../getting-started/git-sync/) enabled.

{% hint style="info" %}
Expand Down
8 changes: 4 additions & 4 deletions collaboration/pdf-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ description: Export a PDF copy of your GitBook content
This feature is available on [Premium and Ultimate site plans](https://www.gitbook.com/pricing).
{% endhint %}

To enable or disable PDF export for visitors to your [published docs site](broken-reference), open the docs site’s dashboard and click the **Settings** tab.&#x20;

You can enable PDF export by toggling it on in the **Customization** section.&#x20;
To enable or disable PDF export for visitors to your [published docs site](broken-reference), open the docs site’s dashboard and click the **Settings** tab, then select the **Features** section. You can toggle it on and off here.

This setting determines whether or not **readers of your published content can download it in PDF format**. This feature is only available for **Standard and Premium sites**.&#x20;

Expand All @@ -30,6 +28,8 @@ However you decide to configure your published docs sites, all logged-in members

#### Export an entire space

1. Open the[ Actions menu](../creating-content/content-structure/) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the page title and choose **Export as PDF > All pages**. Alternatively, open the **Space options** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> menu on the far right of the space header and choose **Export as PDF** in the drop-down menu.
1. Open the[ Actions menu](../creating-content/content-structure/) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the page title and choose **Export as PDF > All pages**. Alternatively, open the space’s **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> in the [space header](../resources/gitbook-ui.md#space-header) and choose **Export as PDF** in the drop-down menu.\
\
&#xNAN;_&#x4E;ote: This action is not available within a change request._
2. Wait for the page to load, then click the **Print or save as PDF** button in the upper right to open your browsers Print menu.
3. From here, you can save the page as a PDF or open it in your PDF viewer using the typical process for your browser.
2 changes: 1 addition & 1 deletion creating-content/broken-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can add different [types of links](formatting/inline.md#links) to your pages
Broken link detection currently works only for relative links to other GitBook content in your organization. It will not detect broken links to external URLs.
{% endhint %}

To view broken links, click the broken link symbol in the [space sub-nav](../resources/gitbook-ui.md#space-header-and-sub-navigation) when inside a change request.
To view broken links, click the broken link symbol in the [space header](../resources/gitbook-ui.md#space-header) when inside a change request.

### Fix a broken link

Expand Down
2 changes: 1 addition & 1 deletion creating-content/content-structure/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can create as many pages as you need in a space. They’re all visible on th

When in [live edit](../../collaboration/live-edits.md) mode or in a [change request](../../collaboration/change-requests.md), you can create a new page by clicking **Add new...** > **Page** at the bottom of your table of contents. Alternatively, you can hover between pages in the table of contents and click the **+** icon that appears.

<figure><img src="../../.gitbook/assets/10_01_25_page.svg" alt=""><figcaption><p>An empty page in GitBook. You can see it listed in the table of contents on the left-hand side.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/04_02_25_page.svg" alt=""><figcaption><p>An empty page in GitBook. You can see it listed in the table of contents on the left-hand side.</p></figcaption></figure>

### Can’t see the option to create a new page?

Expand Down
2 changes: 1 addition & 1 deletion creating-content/reusable-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: >-

Reusable content lets you sync content across multiple pages in a GitBook space, so you can edit all instances of the block at the same time.

<figure><img src="../.gitbook/assets/10_01_25_reusable_content.svg" alt=""><figcaption><p>Create reusable content within a space.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/04_02_25_reusable_content.svg" alt=""><figcaption><p>Create reusable content within a space.</p></figcaption></figure>

### **Create reusable content**

Expand Down
2 changes: 1 addition & 1 deletion creating-content/version-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In the Version history of a space, you can see a list of all the actions that ch

### View historical versions of content

To view past versions of your content and see the changes that were made, click the **Version history** <picture><source srcset="../.gitbook/assets/history_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/history_icon_light.svg" alt=""></picture> button from the space’s **Actions menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> in the top-right corner.&#x20;
To view past versions of your content and see the changes that were made, click the **Version history** <picture><source srcset="../.gitbook/assets/history_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/history_icon_light.svg" alt=""></picture> button in the [space header](../resources/gitbook-ui.md#space-header), or open the **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> next to the space or change request title and choose **Version history**.&#x20;

Click on any item in the list to see how your content looked at the point this change was made. This is very similar to how you view [change requests](../collaboration/change-requests.md).

Expand Down
2 changes: 1 addition & 1 deletion getting-started/git-sync/enabling-github-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Set up and authorize the GitHub integration for GitBook

### Getting started

In the space you want to sync with your GitHub repo, head to the space menu in the top right, and select **Configure**. From the provider list, select **GitHub Sync**.
In the space you want to sync with your GitHub repo, head to the [space header](../../resources/gitbook-ui.md#space-header) in the top right, and select **Configure**. From the provider list, select **GitHub Sync**.

<figure><img src="../../.gitbook/assets/10_01_25_git_sync_github.svg" alt=""><figcaption><p>GitHub Sync configuration options.</p></figcaption></figure>

Expand Down
4 changes: 2 additions & 2 deletions publishing-documentation/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can apply customizations to your entire docs site as a site-wide theme, or t

### General

Control how your content looks in the General tab. The available options are:
Control how your content looks in the Customization tab of your site’s dashboard. The available options are:

<details>

Expand Down Expand Up @@ -173,7 +173,7 @@ You can link to your own privacy policy to help visitors understand how your Git

### Customizing sites with multiple sections

<figure><img src="../.gitbook/assets/10_01_25_site_customization.svg" alt=""><figcaption><p>The customization panel in GitBook.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/04_02_2025_site_customization.svg" alt=""><figcaption><p>The customization panel in GitBook.</p></figcaption></figure>

If you have a docs with with multiple sections, you can control the customization of each one individually.

Expand Down
Loading

0 comments on commit 847c231

Please sign in to comment.