-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
118 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Hub settings | ||
--- | ||
|
||
- TOC | ||
{:toc} | ||
|
||
## Slug & Custom domains | ||
|
||
The slug directly affects the URL of your hubs and documentation. By default, it takes the name of your hub, but modifying it allows you to customize the URL. | ||
|
||
Bump.sh does not automatically redirect to the new URL after changing the slug, so be sure to notify your users of this change. | ||
|
||
The Custom Domain option allows you to keep your users within your brand experience by fully customizing the URL of your documentation. | ||
|
||
> [Custom domain requires additional configuration on your end](/help/custom-domains) | ||
{: .warning} | ||
|
||
## Description | ||
|
||
This option allows you to add a description to your hub, and supports Markdown for enhanced text formatting. For instance, you can explain what this collection includes in terms of documentation, share important details, or even provide a contact for questions. | ||
|
||
![](/images/help/slug-hub.png) | ||
|
||
## Default Settings | ||
|
||
These hub settings are applied by default to all the documentation it contains. From the Hub Settings tab, you can customize several general options. | ||
|
||
It is also possible to modify the settings of a documentation within a hub to customize it differently. | ||
|
||
You can customize the visual appearance of your hub and its documentation by adding your logo and favicon directly from this section. By default, Bump.sh automatically generates a social media visual for you (when you share the URL of your hub or documentation on one of them). However, you can still choose your own image by uploading it at this step. | ||
|
||
![](/images/help/hubs-customization.png) | ||
|
||
You can also customize the general color scheme of your hub. | ||
|
||
![](/images/help/color-scheme.png) | ||
|
||
Finally, you can choose to apply a general sorting parameter to all the documentations in your hub with the Group by operations (by path or tag) and Navigation options. | ||
|
||
![](/images/help/operations-navigations.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
title: Hubs | ||
--- | ||
|
||
- TOC | ||
{:toc} | ||
|
||
## What is a hub | ||
|
||
Hubs are a feature available starting from our paid plans: they allow you to manage collections of API documentation simply and efficiently. | ||
|
||
With hubs, your API ecosystem is displayed on a single page, where documentation can be sorted by categories. | ||
|
||
Hubs also provide a unified changelog, making it easy to identify all changes across all the documentation it contains at a glance. Search is also global, allowing you to search across all documentation. | ||
|
||
## Create a hub | ||
|
||
In your dashboard, click on Hubs then on Create a hub. | ||
|
||
![](/images/help/create-hub.png) | ||
|
||
You will be asked to choose a name for the hub, which will be visible to everyone. The slug is the portion of the URL that you can customize but you can also choose to use a custom domain instead: | ||
- By default, on Bump.sh, your hub will be available on this URL https://bump.sh/hub/<your-own-slug> | ||
- With a custom domain, your hub will be available on https://www.custom.domain.com | ||
|
||
Finally, you can decide whether this hub is visible to everyone or only to members of your organization. | ||
|
||
![](/images/help/hub-creation.png) | ||
|
||
## Add documentation to a hub | ||
|
||
### Using the webapp | ||
#### Deploy a new documentation | ||
From the "Hubs" tab, click on "Create Documentation" to add it to the desired hub. You can then specify the documentation's name, its slug, and its access level (Public or private). | ||
During the creation of a stand-alone documentation, you'll also find the option to add it automatically to an existing hub. | ||
#### Transfer an existing documentation | ||
From any documentation, you can choose to move it to an existing hub. The "Hubs Settings" section allows you to choose which hub to associate this documentation with. You can also specify a category if necessary. | ||
|
||
![](/images/help/move-standalone-doc.png) | ||
### Using the CLI | ||
|
||
The CLI allows you to deploy new documentation directly to a hub. It does not support yet the possibility to create a hub, nor to transfer a doc from one hub to another (you will need to do that via the webapp, as described above). | ||
|
||
To deploy a new doc to a hub, execute the following command: | ||
|
||
bump deploy your/doc.yml --doc my-doc --hub hub-slug-or-id --token my-doc-token | ||
Find here the commands and more information about the CLI. | ||
### Using the API | ||
|
||
Bump.sh's API allows you to upload new versions of your API documentation directly to your hub. | ||
|
||
[For more information, please refer to our API documentation.](https://developers.bump.sh/group/endpoint-versions) | ||
|
||
## Hub access management | ||
|
||
[Access Management](/help/access-management) functions in a similar way for hubs, with a few exceptions. | ||
|
||
The Access Management settings for a hub apply to all the documentations within it. | ||
Two settings are possible: | ||
|
||
- Private: All documentations are accessible only to members of your organization and by invitation. | ||
- Public: All documentations are publicly accessible, but you can manually switch them to private in their settings. | ||
|
||
## Group by categories | ||
|
||
Categories are visible on the homepage of your hub and allow you to organize the documentation. You can add one or more categories to your documentation directly from their settings. | ||
From the settings, you can choose to display the documentation sorted by categories. | ||
|
||
![](/images/help/categories.png) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.