diff --git a/src/_data/sidebar.yml b/src/_data/sidebar.yml deleted file mode 100644 index f4c094cd..00000000 --- a/src/_data/sidebar.yml +++ /dev/null @@ -1,157 +0,0 @@ -help: - - label: Home - link: / - icon: home - - label: Getting started - link: /getting-started/ - items: - - label: Important concepts - link: /getting-started/concepts/ - - label: Upload your first API definition - link: /getting-started/upload-your-first-definition/ - - label: Going further - link: /getting-started/going-further/ - icon: zap - - type: category - label: Integrate Bump.sh with your workflow - link: /continuous-integration/ - icon: terminal - items: - - label: Azure Devops - link: /continuous-integration/azure-devops/ - - label: Github Action - link: /continuous-integration/github-actions/ - - label: CI - link: /continuous-integration/ci/ - - label: CLI - link: /continuous-integration/cli/ - - label: API (advanced) - link: /continuous-integration/api/ - - type: category - label: Publish Documentation - link: /publish-documentation/ - icon: book-open-check - items: - - type: page - label: Create and manage documentation - link: /publish-documentation/create-and-manage-documentation/ - - type: page - label: Deploy and release management - link: /publish-documentation/deploy-and-release-management/ - - type: page - label: Branching - link: /publish-documentation/branching/ - - type: page - label: Documentation access management - link: /publish-documentation/documentation-access-management/ - - type: page - label: SEO & GEO - link: /publish-documentation/seo-geo/ - - type: page - label: Provide links to external resources - link: /publish-documentation/external-links/ - - type: page - label: Get feedback from users - link: /publish-documentation/feedback/ - - type: category - label: Documentation experience - link: /documentation-experience/ - icon: pencil-line - items: - - label: API Explorer - link: /documentation-experience/api-explorer/ - - label: Markdown support - link: /documentation-experience/markdown-support/ - - label: Topics - link: /documentation-experience/topics/ - - label: Ask AI & Markdown rendering - link: /documentation-experience/ask-ai-markdown-rendering/ - - type: category - label: Customization Options - link: /customization-options/ - icon: sparkles - items: - - label: Custom domains - link: /customization-options/custom-domains/ - - label: Color, logo and meta images - link: /customization-options/color-logo-meta-images/ - - label: Login page - link: /customization-options/login/ - - label: Operations & Navigation - link: /customization-options/operations-navigation/ - - type: category - label: Changes management - link: /changes-management/ - icon: bell-dot - items: - - label: Changelog - link: /changes-management/changelog/ - - label: Integrations - link: /changes-management/integrations/ - - type: category - label: Hubs - link: /hubs/ - icon: hub - items: - - label: Create and manage hubs - link: /hubs/create-and-manage-hubs/ - - label: General hub settings - link: /hubs/hub-settings/ - - label: Hub UI customization - link: /hubs/customize-ui - - type: category - label: Organizations - link: /organizations/ - icon: org - items: - - label: Create and manage organizations - link: /organizations/create-and-manage-organizations/ - - label: Organization Access Management - link: /organizations/organization-access-management/ - - label: Personal user account migration - link: /organizations/personal-user-account-migration/ - - label: Account - icon: user - items: - - label: User account settings - link: /account/user-account-settings/ - - label: Billing - link: /account/billing/ - - type: category - label: Specification Support - link: /specification-support/ - icon: code-file - items: - - label: Common elements - items: - - label: JSON Schema - link: /specification-support/json-schema/ - - label: Multiple servers - link: /specification-support/multiple-servers/ - - label: Overlays - link: /specification-support/overlays/ - - label: Polymorphism - link: /specification-support/polymorphism/ - - label: References - link: /specification-support/references/ - - label: Specification extensions - link: /specification-support/extensions/ - - label: Badges - link: /specification-support/doc-badges/ - - label: Custom meta tags - link: /specification-support/meta-tags/ - - label: OpenAPI support - link: /specification-support/openapi-support/ - items: - - label: Webhooks - link: /specification-support/openapi-support/webhooks/ - - label: Custom code samples - link: /specification-support/doc-code-samples/ - - label: AsyncAPI support - link: /specification-support/asyncapi-support/ - - label: FAQ - link: /faq/ - icon: help-circle - - label: Support and SLA - link: /support-and-sla/ - icon: heart-plus diff --git a/src/_data/sidebars/help.yml b/src/_data/sidebars/help.yml index afc4ee5c..d610f558 100644 --- a/src/_data/sidebars/help.yml +++ b/src/_data/sidebars/help.yml @@ -15,7 +15,83 @@ resources: link: /getting-started/going-further/ icon: zap - type: category - label: Integrate Bump.sh with your workflow + label: API documentation + icon: documentation + items: + - type: category + label: Publish documentation + link: /publish-documentation/ + items: + - type: page + label: Create and manage documentation + link: /publish-documentation/create-and-manage-documentation/ + - type: page + label: Deploy and release management + link: /publish-documentation/deploy-and-release-management/ + - type: page + label: Branching + link: /publish-documentation/branching/ + - type: page + label: Documentation access management + link: /publish-documentation/documentation-access-management/ + - type: page + label: SEO & GEO + link: /publish-documentation/seo-geo/ + - type: page + label: Provide links to external resources + link: /publish-documentation/external-links/ + - type: page + label: Get feedback from users + link: /publish-documentation/feedback/ + - type: category + label: Documentation experience + link: /documentation-experience/ + items: + - label: API Explorer + link: /documentation-experience/api-explorer/ + - label: Markdown support + link: /documentation-experience/markdown-support/ + - label: Topics + link: /documentation-experience/topics/ + - label: Ask AI & Markdown rendering + link: /documentation-experience/ask-ai-markdown-rendering/ + - type: category + label: Customization options + link: /customization-options/ + items: + - label: Custom domains + link: /customization-options/custom-domains/ + - label: Branding customization + link: /customization-options/color-logo-meta-images/ + - label: Login page + link: /customization-options/login/ + - label: Operations & navigation + link: /customization-options/operations-navigation/ + - label: Head injection (analytics and tools integration) + link: /customization-options/head-injection-analytics-tools-integration/ + - label: Embed mode + link: /customization-options/embed-mode/ + - type: category + label: Changes management + link: /changes-management/ + items: + - label: Changelog + link: /changes-management/changelog/ + - label: Integrations + link: /changes-management/integrations/ + - type: category + label: Hubs + link: /hubs/ + icon: hub + items: + - label: Create and manage hubs + link: /hubs/create-and-manage-hubs/ + - label: General hub settings + link: /hubs/hub-settings/ + - label: Hub UI customization + link: /hubs/customize-ui/ + - type: category + label: CI & integrations link: /continuous-integration/ icon: terminal items: @@ -33,82 +109,6 @@ resources: link: /continuous-integration/cli/ - label: API (advanced) link: /continuous-integration/api/ - - type: category - label: Publish Documentation - link: /publish-documentation/ - icon: book-open-check - items: - - type: page - label: Create and manage documentation - link: /publish-documentation/create-and-manage-documentation/ - - type: page - label: Deploy and release management - link: /publish-documentation/deploy-and-release-management/ - - type: page - label: Branching - link: /publish-documentation/branching/ - - type: page - label: Documentation access management - link: /publish-documentation/documentation-access-management/ - - type: page - label: SEO & GEO - link: /publish-documentation/seo-geo/ - - type: page - label: Provide links to external resources - link: /publish-documentation/external-links/ - - type: page - label: Get feedback from users - link: /publish-documentation/feedback/ - - type: category - label: Documentation experience - link: /documentation-experience/ - icon: pencil-line - items: - - label: API Explorer - link: /documentation-experience/api-explorer/ - - label: Markdown support - link: /documentation-experience/markdown-support/ - - label: Topics - link: /documentation-experience/topics/ - - label: Ask AI & Markdown rendering - link: /documentation-experience/ask-ai-markdown-rendering/ - - type: category - label: Customization Options - link: /customization-options/ - icon: sparkles - items: - - label: Custom domains - link: /customization-options/custom-domains/ - - label: Branding customization - link: /customization-options/color-logo-meta-images/ - - label: Login page - link: /customization-options/login/ - - label: Operations & Navigation - link: /customization-options/operations-navigation/ - - label: Head injection (analytics and tools integration) - link: /customization-options/head-injection-analytics-tools-integration/ - - label: Embed mode - link: /customization-options/embed-mode/ - - type: category - label: Changes management - link: /changes-management/ - icon: bell-dot - items: - - label: Changelog - link: /changes-management/changelog/ - - label: Integrations - link: /changes-management/integrations/ - - type: category - label: Hubs - link: /hubs/ - icon: hub - items: - - label: Create and manage hubs - link: /hubs/create-and-manage-hubs/ - - label: General hub settings - link: /hubs/hub-settings/ - - label: Hub UI customization - link: /hubs/customize-ui/ - type: category label: Organizations link: /organizations/ @@ -116,19 +116,12 @@ resources: items: - label: Create and manage organizations link: /organizations/create-and-manage-organizations/ - - label: Organization Access Management + - label: Organization access management link: /organizations/organization-access-management/ - - label: Personal user account migration - link: /organizations/personal-user-account-migration/ - - label: Account - icon: user - items: - - label: User account settings - link: /account/user-account-settings/ - label: Billing link: /account/billing/ - type: category - label: Specification Support + label: Specification support link: /specification-support/ icon: code-file items: diff --git a/src/_help/account/user-account-settings.md b/src/_help/account/user-account-settings.md deleted file mode 100644 index cd30089a..00000000 --- a/src/_help/account/user-account-settings.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: User account settings ---- - -- TOC -{:toc} - -Accessible from the Dashboard, the Account Settings page allows you to quickly modify certain elements related to your account. - -From this page, you can modify: - -- your first and last name -- your password - -## Delete your account - -If necessary, you can initiate the deletion of your Bump.sh account from this section. Deleting your account will result in the removal of all data related to you: documentation, hubs, etc... - -> This option is irreversible: we cannot restore the deleted content, even upon request. -> Your data is truly erased from our servers once this request is validated on your end: it is NOT a soft-delete. -{: .warning} - -![](/images/help/account-settings.png) - -## Organization tab - -The Organizations tab shows the list of organizations your account has access to, along with their settings if you are an admin. New organizations can also be created from this section. - -![](/images/help/organization-settings.png) diff --git a/src/_help/hubs/create-and-manage-hubs.md b/src/_help/hubs/create-and-manage-hubs.md index d5870b43..608a5c60 100644 --- a/src/_help/hubs/create-and-manage-hubs.md +++ b/src/_help/hubs/create-and-manage-hubs.md @@ -65,7 +65,7 @@ However, the API does not currently support the following actions: [Access Management](/help/publish-documentation/documentation-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. +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. diff --git a/src/_help/index.md b/src/_help/index.md index 8f9c39da..3d0a773e 100644 --- a/src/_help/index.md +++ b/src/_help/index.md @@ -9,7 +9,7 @@ Learn how to get the most of Bump.sh for your API ecosystem. - [Getting started](/help/getting-started) -- Learn about Bump.sh, how to deploy your first specification file and explore the possibilities. - [Specification support](/help/specification-support) -- Which and how specifications are supported. -- [Changes Management](/help/changes-management) -- Never miss any changes of your API, check them with the diff. +- [Changes management](/help/changes-management) -- Never miss any changes of your API, check them with the diff. ## Manage your documentation and access - [Hubs](/help/hubs) -- Create groups of documentation. diff --git a/src/_help/organizations/organization-access-management.md b/src/_help/organizations/organization-access-management.md index 6078e620..48308b01 100644 --- a/src/_help/organizations/organization-access-management.md +++ b/src/_help/organizations/organization-access-management.md @@ -1,13 +1,10 @@ --- -title: Organization Access Management +title: Organization access management --- - TOC {:toc} -> The Access Management features available depend on the [subscribed plan](https://bump.sh/pricing/). -{: .info} - ## Roles The roles allow you to precisely choose which permissions to assign to members of your organization. The details of permissions by role are available below: diff --git a/src/_help/organizations/personal-user-account-migration.md b/src/_help/organizations/personal-user-account-migration.md deleted file mode 100644 index de581ce8..00000000 --- a/src/_help/organizations/personal-user-account-migration.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Personal user account migration ---- - -- TOC -{:toc} - -> The following information is for users who created their account before February 15, 2024. -{: .info} - -Since the launch of Bump.sh, we've noticed that the approach we initially chose was no longer suited to our users. Indeed, they heavily utilize Bump.sh collaboratively. - -To accommodate this evolution and prepare for future features, we've decided to transform personal user accounts into organizations. - -## What does this change mean for me? - -For our new users, the change mainly occurs during registration, where you'll be asked to create your organization. You'll enjoy all the features of organizations during your free trial. At the end of it, you can choose to [continue benefiting from the full potential of organizations](https://bump.sh/pricing) or switch to a free plan. - -For our existing users, we've made some significant changes regarding your personal user account. -If you hadn't used your personal user account, nothing changes: you're still associated with your usual organizations. - -If you had hubs and documentations in your personal user account: - -- A new organization has been created, adopting your slug/username. -- All your hubs and documentation have been migrated to this organization. -- Your existing URLs remain the same and still work; we haven't touched them at all. - -## What impact should you expect on pricing? - -Previously, organizations were a feature reserved for our paid plans. To accommodate this transition, users on a Free plan now have access to an organization, which includes only public access documentation. - -All other organization features (such as access management, invitations, collaborative work) remain reserved for our paid plans. \ No newline at end of file diff --git a/src/_help/publish-documentation/documentation-access-management.md b/src/_help/publish-documentation/documentation-access-management.md index cae04acf..ad80b6ec 100644 --- a/src/_help/publish-documentation/documentation-access-management.md +++ b/src/_help/publish-documentation/documentation-access-management.md @@ -17,9 +17,6 @@ They require user authentication to be accessible and are not indexed by search ![](/images/help/documentation-access-choice.png) -> The Access Management features available depend on the [subscribed plan](https://bump.sh/pricing/). -{: .info} - ## Private ### Members of an organization diff --git a/src/_help/publish-documentation/index.md b/src/_help/publish-documentation/index.md index cc0c0ac5..9414a043 100644 --- a/src/_help/publish-documentation/index.md +++ b/src/_help/publish-documentation/index.md @@ -13,6 +13,6 @@ Bump.sh offers various tools to simplify this process. This section also covers the concept of [branching](/help/publish-documentation/branching/), which allows you to have multiple versions and/or environements of an API (such as v1.0/v2.0 or production and staging). -Finally, [Access Management](/help/publish-documentation/documentation-access-management/) details the different levels of accessibility for your documentation and how to secure access to it. +Finally, [access management](/help/publish-documentation/documentation-access-management/) details the different levels of accessibility for your documentation and how to secure access to it. Next step: [Create your documentation](/help/publish-documentation/create-and-manage-documentation/). \ No newline at end of file diff --git a/src/_product-updates/2024-02-19-new-dashboard-experience.md b/src/_product-updates/2024-02-19-new-dashboard-experience.md index 21991658..6bf9d6e1 100644 --- a/src/_product-updates/2024-02-19-new-dashboard-experience.md +++ b/src/_product-updates/2024-02-19-new-dashboard-experience.md @@ -16,6 +16,4 @@ Until now, each user had their own personal space and could create and/or join o To put it briefly, all documentation and hubs now belong to an organization. For our users, nothing changes or hardly anything: your existing hubs and documentation have been migrated to an organization bearing your username, and your URLs still work. -We have naturally adjusted our Free plan to not impact our users under this plan: it now includes an organization (yours) with all its APIs publicly accessible as before. - -For more information, feel free to check out [our dedicated help page](/help/organizations/personal-user-account-migration/). \ No newline at end of file +We have naturally adjusted our Free plan to not impact our users under this plan: it now includes an organization (yours) with all its APIs publicly accessible as before. \ No newline at end of file diff --git a/src/images/icons/hub.svg b/src/images/icons/hub.svg index fbc12d0d..8e30dde7 100644 --- a/src/images/icons/hub.svg +++ b/src/images/icons/hub.svg @@ -1 +1,3 @@ - + + +