diff --git a/.gitbook/assets/03_02_25_space_header.svg b/.gitbook/assets/03_02_25_space_header.svg new file mode 100644 index 0000000..6925318 --- /dev/null +++ b/.gitbook/assets/03_02_25_space_header.svg @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/04_02_2025_site_customization.svg b/.gitbook/assets/04_02_2025_site_customization.svg new file mode 100644 index 0000000..c085fe1 --- /dev/null +++ b/.gitbook/assets/04_02_2025_site_customization.svg @@ -0,0 +1,215 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/04_02_25_edit_variant.svg b/.gitbook/assets/04_02_25_edit_variant.svg new file mode 100644 index 0000000..54984a3 --- /dev/null +++ b/.gitbook/assets/04_02_25_edit_variant.svg @@ -0,0 +1,210 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/04_02_25_page.svg b/.gitbook/assets/04_02_25_page.svg new file mode 100644 index 0000000..5364f87 --- /dev/null +++ b/.gitbook/assets/04_02_25_page.svg @@ -0,0 +1,212 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/04_02_25_reusable_content.svg b/.gitbook/assets/04_02_25_reusable_content.svg new file mode 100644 index 0000000..c8daadc --- /dev/null +++ b/.gitbook/assets/04_02_25_reusable_content.svg @@ -0,0 +1,210 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/actions-horizontal - dark.svg b/.gitbook/assets/actions-horizontal - dark.svg new file mode 100644 index 0000000..c16c64b --- /dev/null +++ b/.gitbook/assets/actions-horizontal - dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/.gitbook/assets/actions-horizontal.svg b/.gitbook/assets/actions-horizontal.svg new file mode 100644 index 0000000..f73bf82 --- /dev/null +++ b/.gitbook/assets/actions-horizontal.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/collaboration/change-requests.md b/collaboration/change-requests.md index 8161df3..3d52ef3 100644 --- a/collaboration/change-requests.md +++ b/collaboration/change-requests.md @@ -13,7 +13,7 @@ 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. @@ -21,7 +21,7 @@ Once you’re happy with your changes, you can use the button in the header bar ### 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/). @@ -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. @@ -53,14 +53,14 @@ Most reviews will take place in the change request’s [comments](comments.md), #### Diff view -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 @@ -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** 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** 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. diff --git a/collaboration/live-edits.md b/collaboration/live-edits.md index 110e713..3811556 100644 --- a/collaboration/live-edits.md +++ b/collaboration/live-edits.md @@ -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** . +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** . + +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" %} diff --git a/collaboration/pdf-export.md b/collaboration/pdf-export.md index 81dce72..90e8f4c 100644 --- a/collaboration/pdf-export.md +++ b/collaboration/pdf-export.md @@ -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. - -You can enable PDF export by toggling it on in the **Customization** section. +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**. @@ -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/) next to the page title and choose **Export as PDF > All pages**. Alternatively, open the **Space options** 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/) next to the page title and choose **Export as PDF > All pages**. Alternatively, open the space’s **Actions menu** in the [space header](../resources/gitbook-ui.md#space-header) and choose **Export as PDF** in the drop-down menu.\ + \ + &#xNAN;_Note: 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. diff --git a/creating-content/broken-links.md b/creating-content/broken-links.md index 8337f4e..8da98fd 100644 --- a/creating-content/broken-links.md +++ b/creating-content/broken-links.md @@ -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 diff --git a/creating-content/content-structure/page.md b/creating-content/content-structure/page.md index 1b20211..b02e028 100644 --- a/creating-content/content-structure/page.md +++ b/creating-content/content-structure/page.md @@ -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. -

An empty page in GitBook. You can see it listed in the table of contents on the left-hand side.

+

An empty page in GitBook. You can see it listed in the table of contents on the left-hand side.

### Can’t see the option to create a new page? diff --git a/creating-content/reusable-content.md b/creating-content/reusable-content.md index f358109..3866320 100644 --- a/creating-content/reusable-content.md +++ b/creating-content/reusable-content.md @@ -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. -

Create reusable content within a space.

+

Create reusable content within a space.

### **Create reusable content** diff --git a/creating-content/version-control.md b/creating-content/version-control.md index a8612cd..f0f5463 100644 --- a/creating-content/version-control.md +++ b/creating-content/version-control.md @@ -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** button from the space’s **Actions menu** in the top-right corner. +To view past versions of your content and see the changes that were made, click the **Version history** button in the [space header](../resources/gitbook-ui.md#space-header), or open the **Actions menu** next to the space or change request title and choose **Version history**. 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). diff --git a/getting-started/git-sync/enabling-github-sync.md b/getting-started/git-sync/enabling-github-sync.md index fbe9dd3..689c692 100644 --- a/getting-started/git-sync/enabling-github-sync.md +++ b/getting-started/git-sync/enabling-github-sync.md @@ -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**.

GitHub Sync configuration options.

diff --git a/publishing-documentation/customization.md b/publishing-documentation/customization.md index d0af6f8..88276e6 100644 --- a/publishing-documentation/customization.md +++ b/publishing-documentation/customization.md @@ -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:
@@ -173,7 +173,7 @@ You can link to your own privacy policy to help visitors understand how your Git ### Customizing sites with multiple sections -

The customization panel in GitBook.

+

The customization panel in GitBook.

If you have a docs with with multiple sections, you can control the customization of each one individually. diff --git a/publishing-documentation/insights.md b/publishing-documentation/insights.md index b358d5d..fe4aba3 100644 --- a/publishing-documentation/insights.md +++ b/publishing-documentation/insights.md @@ -9,19 +9,31 @@ description: View analytics and insights related to your published documentation This feature is available on [Premium and Ultimate site plans](https://www.gitbook.com/pricing). {% endhint %} -Insights give you information on the content you've published and how it performs. It's split up between different sections — **traffic**, **pages & feedback**, **search**, **ask AI**, **links**, and **OpenAPI**. +Insights give you information on the content you've published and how it performs. It's split up between different sections — **Traffic**, **Pages & feedback**, **Search**, **Ask AI**, **Links**, and **OpenAPI**. -You can find insights for individual docs sites in the docs site dashboard, and can sort it by the last day, week and month. You can download insights by hovering over the header for the data you want, and clicking **Download CSV**. +You can see a top-level overview of your insights on the **Overview** tab of your site’s dashboard, with a globe that shows views in the last hour by location. + +Click the **Insights** tab in the site header to find more detailed insights for your site.

The site insights dashboard.

-### Traffic +### Filters & groups + +You can add filters or group your data to view it in specific ways. For example, you could look at search data within a specific site section, or filter your traffic data by country, device, browser and more. + +By combining filters and groups, you can drill down in to precise analytics data to track the events that you are important to you. + +### Types of data + +The Insights tab is split into six sections, each focused on a specific data type. + +#### Traffic GitBook tracks page views to help you understand the popularity and reach of your content. Each time a user visits a page on your docs site, it is counted as a page view. Page views are critical for assessing the effectiveness of your content strategy and optimizing your documentation based on user interest. It’s split up between different views and profiles, including countries, languages, browsers, and more. -### Pages & Feedback +#### Pages & Feedback Pages & feedback allow you to see a high-level representation of how your users rate your content. You’ll see an overview of all of your site’s sections and variants, and after enabling [page rating](site-settings.md#page-ratings-pro-and-enterprise-plans) in the **Customize** menu for a site, you can see each page’s average feedback rating. @@ -29,29 +41,29 @@ If you want to use or analyze this data further outside of GitBook, click **Down You can also see a list of comments left from visitors who rate your pages, to get actionable insights on how your docs can be improved. -### Search +{% hint style="info" %} +**Why can’t I see any feedback data for my site?**\ +We only display data for published sites with page ratings enabled. If your site is not published or does not have page ratings enabled, you won’t see any insights. +{% endhint %} + +#### Search You can measure and improve your documentation by checking which keywords are used the most by users searching your documentation. This view allows you to see what keywords are performing the best, and which ones you could improve on. The information here can be helpful for informing your content architecture, making certain parts of your documentation easier to find without search, or adding additional content to existing pages based on what your visitors are searching for. -### Ask AI +#### Ask AI The [Ask AI](../creating-content/searching-your-content/gitbook-ai.md) section allows you to see what your users are asking for when using GitBook AI. This insight helps you identify common questions, uncover gaps in your documentation, and improve content to better meet user needs. By looking at these queries, you can refine your documentation structure, enhance discoverability, and provide more relevant information to your audience. -### Links +#### Links GitBook tracks links to help you understand how users interact with external resources in your documentation. This feature provides insights into external links, their domains, and their placement within your docs, such as in the header, footer, or sidebar. Analyzing link usage can help you optimize navigation, improve content accessibility, and refine your documentation strategy based on user engagement. -### OpenAPI +#### OpenAPI The [OpenAPI](../creating-content/openapi/) analytics view in GitBook provides insights into how users engage with your API documentation. It tracks interactions such as endpoint views, parameter searches, and request explorations, helping you understand which parts of your API are most accessed and where users may need more clarity. These insights enable you to refine your documentation, improve developer experience, and ensure your API content is effectively meeting user needs. - -{% hint style="info" %} -**Why can’t I see any data for my site?**\ -We only display data for published sites with page ratings enabled. If your site is not published or does not have page ratings enabled, you won’t see any insights. -{% endhint %} diff --git a/publishing-documentation/site-redirects.md b/publishing-documentation/site-redirects.md index 0777a46..3bb2107 100644 --- a/publishing-documentation/site-redirects.md +++ b/publishing-documentation/site-redirects.md @@ -17,11 +17,11 @@ In addition to [automatic redirects created by GitBook](site-redirects.md#about- ## Managing redirects on your site -To get started, view your site’s dashboard in GitBook and click **Settings** in the top-right corner. Scroll down to the **Redirects** section. +To get started, view your site’s dashboard in GitBook and open the **Settings** tab, then click **Domain & redirects**. ### Creating redirects -Click **Add redirect** to begin. Fill in the source path — i.e. the URL slug that you wish to redirect somewhere else — and the destination content you wish to link to. You can pick any [section](site-structure/site-sections.md), [variant](site-structure/variants.md), or [page](../creating-content/content-structure/page.md) on to your site. Click **Add** to create the redirect. +Click **Add redirect** to begin. Fill in the source path — i.e. the URL slug that you wish to redirect somewhere else — and the destination content you wish to link to. You can pick any [section](site-structure/site-sections.md), [variant](site-structure/variants.md), or [page](../creating-content/content-structure/page.md) on to your site. Click **Add** to create the redirect. If you want to add another redirect to the same page, you can toggle the **Add another redirect** option on before you hit **Add**. When you add your redirect, the modal will remain open with the destination content set to the previous selection so you can add another URL slug immediately. @@ -33,7 +33,7 @@ To delete a redirect, press the **Delete redirect** button and confirm. ## About automatic redirects -Whenever pages are moved or renamed, their canonical URL changes with them. In order to keep your content accessible, GitBook automatically creates a [HTTP 301](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) redirect from the old URL to the new one. +Whenever pages are moved or renamed, their canonical URL changes with them. In order to keep your content accessible, GitBook automatically creates a [HTTP 301](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) redirect from the old URL to the new one. Every time a URL is loaded, GitBook resolves it through the following steps: diff --git a/publishing-documentation/site-structure/README.md b/publishing-documentation/site-structure/README.md index 884e64b..3825f46 100644 --- a/publishing-documentation/site-structure/README.md +++ b/publishing-documentation/site-structure/README.md @@ -15,7 +15,7 @@ Linked spaces can serve as one of two different content types, which determine h ## Managing your site structure -From your docs site’s dashboard, click the **Settings** button, then click **Structure**. Here you can see all the content of your site, divided into sections and variants. +From your docs site’s dashboard, open the **Settings** tab in the site header, then click **Structure**. Here you can see all the content of your site, divided into sections and variants. Your site starts out with a single section with your site's name and a single variant with the space you linked during your site's set-up. @@ -27,11 +27,11 @@ To add a [site section](site-sections.md), click the **Add section** button unde To add a [variant](variants.md), click the **Add variant** button in the section you’d like to add to, then choose a space to link. The new variant is then added to the list of variants within the chosen section and will be available to visitors in the variant dropdown on your site. -When you add a space — as a variant or a section — a name and slug will be generated based on the space’s title. +When you add a space — as a variant or a section — a name and slug will be generated based on the space’s title. ### Changing sections or variants -

Update a site section or variant.

+

Update a site section or variant.

You can change the name and slug of each of sections and variants by clicking the **Edit** button in the table row of the item you’d like to edit. This will open a modal. Edit the field(s) you’d like to change, then click the **Save** button to save. @@ -45,7 +45,7 @@ To replace a section or variant, first delete it by clicking its **Edit** and moving it up or down. The changed order will be reflected on your site immediately. -You can also use the keyboard to select and move content. Select a section or variant with the space bar, then use the arrow keys to move it up or down. Hit the space bar again to confirm the new position. +You can also use the keyboard to select and move content. Select a section or variant with the space bar, then use the arrow keys to move it up or down. Hit the space bar again to confirm the new position. ### Setting default content @@ -61,4 +61,10 @@ Setting a space as default removes its slug field, as it will be served from the ### Remove content from a site -To remove the content of a space from a site, click the **Settings** button from your docs site dashboard, then click **Structure** to find the content you want to remove. Click the **Edit** button next to the space you want to remove, then click the **Delete** button in the lower left of the modal. This will remove it from the published site, but **will not delete the space or the content within**. +To remove the content of a space from a site, open the **Settings** tab from your docs site dashboard, then click **Structure** to find the content you want to remove. + +Open the **Actions menu** for the space you want to remove and choose **Remove**. + +{% hint style="success" %} +Removing a space from your site will remove it from the published site, but **will not delete the space or the content within it**. +{% endhint %} diff --git a/publishing-documentation/site-structure/site-sections.md b/publishing-documentation/site-structure/site-sections.md index 914dc81..6341444 100644 --- a/publishing-documentation/site-structure/site-sections.md +++ b/publishing-documentation/site-structure/site-sections.md @@ -13,13 +13,13 @@ This feature is available on the [Ultimate site plan](https://www.gitbook.com/pr

Example of a GitBook site with Site Sections

-Create a seamless experience for your audience with a site that supports multiple sections, each with its own navigation tree. Perfect for organizing distinct parts of your documentation—whether you're managing separate product versions or catering to both end users and developers with tailored content. +Create a seamless experience for your audience with a site that supports multiple sections, each with its own navigation tree. Perfect for organizing distinct parts of your documentation—whether you're managing separate product versions or catering to both end users and developers with tailored content. The spaces you link as sections can contain any content, but it is recommended to use sections as _semantically different_ parts of your docs. If the spaces you'd like to link are variations of the same content, consider adding them as [content variants](variants.md) instead. ### Adding a section to your docs site -From your docs site’s dashboard, click the **Settings** button, then click **Structure**. Here you can see all the content of your site. +From your docs site’s dashboard, open the **Settings** tab in the site header, then click **Structure**. Here you can see all the content of your site. To add a site section, click the **Add section** button underneath the table and choose a space to link as a section. The new section is then added to the table and will be available to visitors as a tab at the top of your site. @@ -27,7 +27,7 @@ To add a site section, click the **Add section** button underneath the table and ### Editing a section -You can change the name and slug of each of your sections by tapping the **Edit** button in the table row of the section you’d like to edit. This will open a modal. Edit the field(s) you'd like to change, then click the **Save** button to save. You can also delete the variant by clicking the **Delete variant** button in the lower left. +You can change the name and slug of each of your sections by tapping the **Edit** button in the table row of the section you’d like to edit. This will open a modal. Edit the field(s) you'd like to change, then click the **Save** button to save. You can also delete the variant by clicking the **Delete variant** button in the lower left. {% hint style="info" %} Changing a section’s slug will change its canonical URL. GitBook will create an automatic redirect from the old URL to the new one. You can also [manually create redirects](../site-redirects.md). @@ -37,7 +37,7 @@ Changing a section’s slug will change its canonical URL. GitBook will create a Your site displays sections in the order that they appear in your Site structure table. Sections can be reordered by grabbing the **Drag handle** and moving it up or down. All the spaces within that section will be moved with it. The changed order will be reflected on your site immediately. -You can also use the keyboard to select and move content: select a section with the space bar, then use the arrow keys to move it up or down. Hit the space bar again to confirm the new position. +You can also use the keyboard to select and move content: select a section with the space bar, then use the arrow keys to move it up or down. Hit the space bar again to confirm the new position. ### Setting a default section @@ -48,3 +48,11 @@ To set a section as default, click on the **Actions menu** button from your docs site dashboard, then click **Structure** to find the content you want to remove. Click the **Edit** button next to the section you want to remove, then click the **Delete** button in the lower left of the modal. This will remove the section, along with all the variants within it, from the published site. It will not delete the spaces itself, or the content within them. + +To remove a section from a site, open the **Settings** tab from your docs site dashboard, then click **Structure** to find the content you want to remove. + +Open the **Actions menu** for the space you want to remove and choose **Remove**. + +{% hint style="success" %} +Removing a section from your site will remove it — and all variants within it — from the published site, but **will not delete any of the spaces or the content within them**. +{% endhint %} diff --git a/publishing-documentation/site-structure/variants.md b/publishing-documentation/site-structure/variants.md index 00f649e..b1e6970 100644 --- a/publishing-documentation/site-structure/variants.md +++ b/publishing-documentation/site-structure/variants.md @@ -21,13 +21,13 @@ The spaces you link can contain any content, but it’s recommended to use varia ### Adding a variant to your docs site -From your docs site’s dashboard, click the **Settings** button, then click **Structure**. Here you can see all the content of your site. +From your docs site’s dashboard, open the **Settings** tab in the site header, then click **Structure**. Here you can see all the content of your site. To add a variant, click the **Add variant** button in the section you'd like to add to, then choose a space to link. The new variant is then added to the list of variants within the chosen section and will be available to visitors in the variant dropdown on your site. ### Changing a variant -You can change the name and slug of each of your variants by tapping the **Edit** button in the table row of the variant you’d like to edit. This will open a modal. Edit the field(s) you'd like to change, then click the **Save** button to save. You can also delete the variant by clicking the **Delete variant** button in the lower left. +You can change the name and slug of each of your variants by clicking the **Edit** button in the table row of the variant you’d like to edit. This will open a modal. Edit the field(s) you'd like to change, then click the **Save** button to save. You can also delete the variant by clicking the **Delete variant** button in the lower left. {% hint style="info" %} Changing a linked space's slug will change the space's canonical URL. GitBook will create an automatic redirect from the old URL to the new one. You can also [manually create redirects](../site-redirects.md). @@ -53,4 +53,10 @@ Setting a variant as default removes its slug field, as it will be served from t ### Remove a variant from a site -To remove a variant from a site, click the **Settings** button from your docs site dashboard, then click **Structure** to find the content you want to remove. Click the **Edit** button next to the variant you want to remove, then click the **Delete variant** button in the lower left of the modal. This will remove it from the published site, but will not delete the variant or the content within. +To remove a variant from a site, open the **Settings** tab from your docs site dashboard, then click **Structure** to find the content you want to remove. + +Open the **Actions menu** for the variant you want to remove and choose **Remove**. + +{% hint style="success" %} +Removing a variant from your site will remove it from the published site, but **will not delete the space or the content within it**. +{% endhint %} diff --git a/resources/gitbook-ui.md b/resources/gitbook-ui.md index c7f2b66..7326796 100644 --- a/resources/gitbook-ui.md +++ b/resources/gitbook-ui.md @@ -13,25 +13,25 @@ GitBook is split into different sections to make it easier to organize and manag The sidebar allows you to see and overview of your GitBook organization at a glance. The sidebar contains: -- **Organization switcher**\ +* **Organization switcher**\ If you’re a part of multiple organizations, you can see and switch between them here. You can also create a new organization from this menu. -- **Notifications**\ +* **Notifications**\ When you’re tagged in a comment or conversation, or when there is important activity in a space you’re working in, you’ll get a [notification](../collaboration/notifications.md) to show you what’s new. -- **Ask or search**\ +* **Ask or search**\ Powered by [GitBook AI](../creating-content/searching-your-content/gitbook-ai.md), you can ask questions in natural language, or search through the different spaces and content in your organization. -- **Home**\ +* **Home**\ The Home page allows you to see everything your team is working on at a glance. View open change requests, discussions and comments, recent page edits and more. -- **Docs sites home**\ +* **Docs sites home**\ Click this to visit the overview page for all the docs sites you have created in your organization. -- **Integrations**\ +* **Integrations**\ GitBook [integrations](../content-editor/editor/broken-reference/) supercharge your content, allowing you to embed more into your pages, or add information to your knowledge base from other apps. -- **Docs sites**\ +* **Docs sites**\ Toggle this section to view all the [docs sites](../publishing-documentation/publish-a-docs-site/) in your organization right in the sidebar and jump to one with a click. -- **Spaces**\ +* **Spaces**\ The spaces section is where you’ll find the [collections](../creating-content/content-structure/collection.md) and [spaces](../creating-content/content-structure/space.md) you create when adding more content. Head to our [content structure](../creating-content/content-structure/) section to find out more. -- **Settings**\ +* **Settings**\ You’ll find [personal settings](../account-management/account-settings.md) and [organization settings](../account-management/organization-settings.md) at the bottom of the sidebar. Here, you can also toggle light/dark mode, or get help from our support team if needed. -- **Trash**\ +* **Trash**\ Deleted spaces appear in the trash. You can restore them for up to seven days — after that, they’re permanently deleted. ### Table of contents @@ -44,74 +44,106 @@ The table of contents is also where you can view and manage [resuable content](. From the **Pages** tab in the table of contents you can: -- Create new [pages](gitbook-ui.md#pages) and subpages -- Create [page groups](gitbook-ui.md#groups) -- Add [external links](gitbook-ui.md#external-links) -- [import external docs](../getting-started/import.md) like websites or Markdown files -- Access [the Actions menu](gitbook-ui.md#the-actions-menu) for individual pages. +* Create new [pages](gitbook-ui.md#pages) and subpages +* Create [page groups](gitbook-ui.md#groups) +* Add [external links](gitbook-ui.md#external-links) +* [import external docs](../getting-started/import.md) like websites or Markdown files +* Access [the Actions menu](gitbook-ui.md#the-actions-menu) for individual pages. In the **Reusable content** tab, you can: -- View and search through the reusable content in the space -- Create new reusable content -- Drag and drop reusable content onto the page -- Rename and delete reusable content +* View and search through the reusable content in the space +* Create new reusable content +* Drag and drop reusable content onto the page +* Rename and delete reusable content In the **Files** tab, you can: -- View, search and reorder the files in your space -- Drag and drop more files into your space -- Manage individual files +* View, search and reorder the files in your space +* Drag and drop more files into your space +* Manage individual files If you want to give more focus to the content of your page, you can temporarily hide the table of contents by hovering your cursor next to it and clicking the **Hide** button that appears. To make it appear again, hover your cursor near the edge of the page and click the **Show** button . -### Space overview & space header +### Space header -

The space header sits at the top of the editor, and offers options that apply to the whole space.

+

The space header sits at the top of the editor, and offers options that apply to the whole space.

-The space overview contains information about the space you’re currently viewing. It lets you do things like publish and share your space, configure [GitHub or GitLab sync](../getting-started/git-sync/), and more. +The space header contains information about the space you’re currently viewing. It lets you do things like publish and share your space, view the comments and history for the space, configure [GitHub or GitLab sync](../getting-started/git-sync/), and more. {% hint style="info" %} -The space overview & space header may look different depending on the mode you’re currently in. See [change requests](../collaboration/change-requests.md) for more info. -{% endhint %} +The space header is adaptable, and changes depending on the space and mode you’re currently in. -#### Space overview +For example, if you’re editing a [change request](../collaboration/change-requests.md), you will see options to open the editor, view changes and merge your change request. If you’re viewing a read-only space, you will have the option to open a new change request, but won’t have an editor option. +{% endhint %} -The space overview appears at the top of GitBook when viewing a space. It includes: +The space header includes: -- **The space’s breadcrumbs**\ +* **The space emoji or icon**\ + You can choose an emoji or icon for your space, to help you easily identify it in the sidebar. +* **The space name**\ + The name of the space that will appear in the sidebar, and your documentation if and when you choose to publish it. +* **The space’s breadcrumbs**\ A full, linear list of the collections or docs sites the space lives in. -- **Collaborators**\ +* **Actions menu** \ + Offers a list of actions for your space. Similar to [page actions](gitbook-ui.md#the-actions-menu), the available actions for a space will differ depending on the mode you’re currently in. +* **Editor view**\ + This view is where you can make edits to your content using GitBook’s block-based editor. +* **Changes view**\ + This view [highlights the changes](../collaboration/change-requests.md#diff-mode) made within a change request using the diff view. This is ideal for reviewing new content before merging your change request to push the changes live. +* **Preview**\ + This view allows you to quickly see a preview of your content before you merge a change request. +* **Collaborators**\ The avatar of anyone else who’s currently viewing a page in your space, with colored circles to show their cursor color. Click an avatar to jump to the page they’re currently viewing. -- **Git Sync configuration**\ +* **Git Sync configuration**\ The [GitHub and GitLab Sync](../getting-started/git-sync/) configuration for your space. -- **The Share menu**\ +* **The Share menu**\ Allows you to publish and share your space. You can also invite others to [collaborate](../content-editor/editor/broken-reference/) through this menu. -- **Actions menu** \ - Offers a list of actions for your space. Similar to [page actions](gitbook-ui.md#the-actions-menu), the available actions for a space will differ depending on the mode you’re currently in. +* **Comments**\ + See the [comments and discussions](../collaboration/comments.md) you and your team have had about the space content. +* **Broken links**\ + Any [broken links](../creating-content/broken-links.md) that have been found in the current space or change request. +* **Change requests**\ + Create, update, and delete [change requests](../collaboration/change-requests.md) in your space. +* **Space history**\ + View [a version history](../creating-content/version-control.md) that includes all the changes made in the space — or in your current change request — over time. +* **The Edit button**\ + If your space is published, or someone has locked[ live edits](../collaboration/live-edits.md), the **Edit** button will appear in the space header. It will create a new [change request](../collaboration/change-requests.md) to edit content. -#### Space header +### Site header -The space header is located directly beneath the space overview, and lets you collaborate with others on your space, customize it’s look, and more. It includes: +The site header contains information about the site you’re currently viewing. It lets you do things like view site insights, customize your site, change its settings and preview the site in different modes and screen sizes. You can also configure integrations and manage members’ access. -- **The space emoji or icon**\ - You can choose an emoji or icon for your space, to help you easily identify it in the sidebar. -- **The space name**\ +The site header includes: + +* **The site name**\ The name of the space that will appear in the sidebar, and your documentation if and when you choose to publish it. -- **Comments**\ - See the [comments and discussions](../collaboration/comments.md) you and your team have had about the space content. -- **Broken links**\ - Any [broken links](../creating-content/broken-links.md) that have been found in the current space or change request. -- **Change requests**\ - Create, update, and delete [change requests](../collaboration/change-requests.md) in your space. -- **The edit button**\ - If your space is published, or someone has locked[ live edits](../collaboration/live-edits.md), the **Edit in change request** button will appear in the space header. It lets you start a new [change request](../collaboration/change-requests.md) to edit content. +* **The site’s breadcrumbs**\ + A link back to the main Docs sites screen. +* **Actions menu** \ + Offers a list of actions for your site. You can visit your site or copy its URL quickly from this menu +* **Overview**\ + The site overview shows you essential information about your site including it’s URL, publish status, audience and content, as well as top-level insights. +* **Insights**\ + The [insights panel](../publishing-documentation/insights.md) gives you detailed anayltics about your site and how it’s performing. +* **Customization**\ + Here you can [customize your site](../publishing-documentation/customization.md) with your own logo, colors, header links, and much more. +* **Settings**\ + Access your [site’s settings](../publishing-documentation/site-settings.md) and control the name, audience, content structure and other options. +* **Preview**\ + The preview tab lets you quickly see how your published site will look in light and dark mode across desktop and mobile displays. +* **Integrations**\ + The button opens a modal that lets you install and configure [integrations](../integrations/install-an-integration.md) for your site. +* **Member access**\ + View and manage who can access your site in the GitBook app, and what permissions they have. +* **Visit site**\ + Click this to instantly open your published docs site in a new tab. This button only appears when your site is live. ### Content editor The editor is the main part of your space, where you can write or insert content in GitBook. -In addition to the multiple [content blocks](../creating-content/blocks/) you can insert, you can also [embed content](../creating-content/blocks/embed-a-url.md) and use certain [integrations](broken-reference). +In addition to the multiple [content blocks](../creating-content/blocks/) you can insert, you can also [embed content](../creating-content/blocks/embed-a-url.md) and use certain [integrations](broken-reference/). ### Page title and description @@ -123,7 +155,7 @@ Your page description can be a maximum of 200 characters long, and will act as t You can change the URL slug for a page by choosing **Page Actions** > **Rename**. Find out more about [Page Actions](gitbook-ui.md#page-options) below. {% endhint %} -### The Actions menu +### Page actions menu The page’s **Actions menu** allows you to do things like duplicate, rename or delete your page. diff --git a/resources/glossary.md b/resources/glossary.md index db75619..d9b009c 100644 --- a/resources/glossary.md +++ b/resources/glossary.md @@ -6,7 +6,7 @@ icon: book-open ### A -**Actions menu:** The menu that opens when you click the three vertical dots next to a page or in the space header. The Actions menu may show different options depending on your current view mode. +**Actions menu:** The menu that opens when you click the three dots next to a page or item in the GitBook interface. The Actions menu may show different options depending on your current view mode. **Add new:** The button/menu at the bottom of a space’s table of contents that lets you add new content to your space. Also used to refer to the **+** buttons next to the **Docs sites** and **Spaces** section headers in the sidebar, which you can click to create a new site, space or collection.