From 32d0fa130e6545eef7066f70553646ffdabb5fc8 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Fri, 12 May 2023 14:54:49 -0700 Subject: [PATCH] Update brand terminology --- dev-resources/README.md | 2 +- dev-resources/algolia-search/README.md | 4 +-- dev-resources/file-mappings/README.md | 2 +- .../projects-and-namespaces.md | 2 +- .../rancher-extensions.md | 4 +-- docusaurus.config.js | 2 +- .../current.json | 12 ++++----- .../rancher-extensions.md | 4 +-- .../version-2.0-2.4.json | 12 ++++----- .../version-2.5.json | 12 ++++----- .../version-2.6.json | 12 ++++----- sidebars.js | 4 +-- .../introduction/what-are-divio-docs.md | 26 +++++++++---------- .../pages-for-subheaders/introduction.md | 2 +- .../version-2.0-2.4/reference-guides.md | 4 +-- .../introduction/what-are-divio-docs.md | 26 +++++++++---------- .../pages-for-subheaders/introduction.md | 2 +- .../version-2.5/reference-guides.md | 4 +-- .../version-2.0-2.4-sidebars.json | 4 +-- versioned_sidebars/version-2.5-sidebars.json | 4 +-- versioned_sidebars/version-2.6-sidebars.json | 4 +-- 21 files changed, 74 insertions(+), 74 deletions(-) diff --git a/dev-resources/README.md b/dev-resources/README.md index bad53375334..138c3d3c653 100644 --- a/dev-resources/README.md +++ b/dev-resources/README.md @@ -1,3 +1,3 @@ # Dev Resources -This folder contains resources intended to help ease the process of maintaining and/or contributing to the Rancher Manager Documentation. +This folder contains resources intended to help ease the process of maintaining and/or contributing to the Rancher Documentation. diff --git a/dev-resources/algolia-search/README.md b/dev-resources/algolia-search/README.md index 0a70707615c..4db80e4c9b3 100644 --- a/dev-resources/algolia-search/README.md +++ b/dev-resources/algolia-search/README.md @@ -1,6 +1,6 @@ -# Algolia with Rancher Manager Documentation +# Algolia with Rancher Documentation -The search index used by the Rancher Manager documentation is generated by [running our own crawler](https://docsearch.algolia.com/docs/legacy/run-your-own). +The search index used by the Rancher documentation is generated by [running our own crawler](https://docsearch.algolia.com/docs/legacy/run-your-own). ## Running the Crawler diff --git a/dev-resources/file-mappings/README.md b/dev-resources/file-mappings/README.md index ce546bb7392..83af511231f 100644 --- a/dev-resources/file-mappings/README.md +++ b/dev-resources/file-mappings/README.md @@ -1,6 +1,6 @@ # File Mappings -The content structure of the the Rancher Manager documentation has undergone substantial changes. +The content structure of the the Rancher documentation has undergone substantial changes. In this folder, you can find files containing mappings for pages from our current documentation to our previous documentation1. diff --git a/docs/how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md b/docs/how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md index dd90a955ea8..f9b32deae1f 100644 --- a/docs/how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md +++ b/docs/how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md @@ -191,7 +191,7 @@ To add a resource quota, 1. In the upper left corner, click **☰ > Cluster Management**. 1. On the **Clusters** page, go to the cluster the project is attached to, and click **Explore**. 1. Click **Cluster > Projects/Namespaces**. -1. Find the project you want to delete, and click **⋮**. +1. Find the project you want to delete, and click **⋮**. 1. Select **Delete**. When you delete a project, any namespaces that were formerly associated with the project will remain on the cluster. You can find these namespaces in the Rancher UI, in the **Not in a Project** tab of the **Projects/Namespaces** page. You can reassign these namespaces to a project by [moving](../manage-namespaces.md#moving-namespaces-to-another-project) them. diff --git a/docs/integrations-in-rancher/rancher-extensions.md b/docs/integrations-in-rancher/rancher-extensions.md index ccbba897f68..0a86dad7d2d 100644 --- a/docs/integrations-in-rancher/rancher-extensions.md +++ b/docs/integrations-in-rancher/rancher-extensions.md @@ -2,11 +2,11 @@ title: Rancher Extensions --- -New in Rancher v2.7.0, Rancher introduces **extensions**. Extensions allow users, developers, partners, and customers to extend and enhance the Rancher Manager UI. In addition, users can make changes and create enhancements to their UI functionality independent of Rancher Manager releases. Extensions will enable users to build on top of Rancher to better tailor it to their respective environments. Note that users will also have the ability to update to new versions as well as roll back to a previous version. +New in Rancher v2.7.0, Rancher introduces **extensions**. Extensions allow users, developers, partners, and customers to extend and enhance the Rancher UI. In addition, users can make changes and create enhancements to their UI functionality independent of Rancher releases. Extensions will enable users to build on top of Rancher to better tailor it to their respective environments. Note that users will also have the ability to update to new versions as well as roll back to a previous version. Extensions are Helm charts that can only be installed once into a cluster; therefore, these charts have been simplified and separated from the general Helm charts listed under **Apps**. -Examples of built-in Rancher Manager extensions are Fleet, Explorer, and Harvester. Examples of other extensions that use the Extensions API that can be manually added are Kubewarden and Elemental. +Examples of built-in Rancher extensions are Fleet, Explorer, and Harvester. Examples of other extensions that use the Extensions API that can be manually added are Kubewarden and Elemental. ## Prerequisites diff --git a/docusaurus.config.js b/docusaurus.config.js index ea54328d887..5a5295790d1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,7 +1,7 @@ /** @type {import('@docusaurus/types').DocusaurusConfig} */ module.exports = { - title: 'Rancher Manager', + title: 'Rancher', tagline: '', url: 'http://ranchermanager.docs.rancher.com/', baseUrl: '/', diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json index df65e73a961..602aafde072 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh/docusaurus-plugin-content-docs/current.json @@ -11,9 +11,9 @@ "message": "快速入门指南", "description": "The label for category Quick Start Guides in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Deploy Rancher Manager": { - "message": "部署 Rancher Manager", - "description": "The label for category Deploy Rancher Manager in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Deploy Rancher": { + "message": "部署 Rancher", + "description": "The label for category Deploy Rancher in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Deploy Rancher Workloads": { "message": "部署 Rancher 工作负载", @@ -243,9 +243,9 @@ "message": "Rancher 管理的集群", "description": "The label for category Rancher-Managed Clusters in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Rancher Manager Architecture": { - "message": "Rancher Manager 架构", - "description": "The label for category Rancher Manager Architecture in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Rancher Architecture": { + "message": "Rancher 架构", + "description": "The label for category Rancher Architecture in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Cluster Configuration": { "message": "集群配置", diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/rancher-extensions.md b/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/rancher-extensions.md index 7d8bec8a128..0f6de8e5900 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/rancher-extensions.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/integrations-in-rancher/rancher-extensions.md @@ -2,11 +2,11 @@ title: Rancher 扩展 --- -Rancher v2.7.0 引入了**扩展（Extension）**的新功能。扩展允许用户、开发人员、合作伙伴和客户扩展和增强 Rancher Manager UI。此外，用户可以独立于 Rancher Manager 版本对其 UI 功能进行更改和增强。有了扩展，用户能够在 Rancher 之上进行构建，从而更好地根据环境进行定制。用户还可以更新到新版本以及回滚到以前的版本。 +Rancher v2.7.0 引入了**扩展（Extension）**的新功能。扩展允许用户、开发人员、合作伙伴和客户扩展和增强 Rancher UI。此外，用户可以独立于 Rancher 版本对其 UI 功能进行更改和增强。有了扩展，用户能够在 Rancher 之上进行构建，从而更好地根据环境进行定制。用户还可以更新到新版本以及回滚到以前的版本。 扩展是只能在集群中安装一次的 Helm Chart。因此，这些 Chart 已经过简化，并与 **Apps** 下列出的常规 Helm Chart 分开。 -内置的 Rancher Manager 扩展示例包括 Fleet、Explorer 和 Harvester。使用可手动添加的 Extensions API 的其他扩展示例包括 Kubewarden 和 Elemental。 +内置的 Rancher 扩展示例包括 Fleet、Explorer 和 Harvester。使用可手动添加的 Extensions API 的其他扩展示例包括 Kubewarden 和 Elemental。 ## 先决条件 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.0-2.4.json b/i18n/zh/docusaurus-plugin-content-docs/version-2.0-2.4.json index 8fbfbd2cdeb..bb5510705eb 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.0-2.4.json +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.0-2.4.json @@ -15,9 +15,9 @@ "message": "Quick Start Guides", "description": "The label for category Quick Start Guides in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Deploy Rancher Manager": { - "message": "Deploy Rancher Manager", - "description": "The label for category Deploy Rancher Manager in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Deploy Rancher": { + "message": "Deploy Rancher", + "description": "The label for category Deploy Rancher in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Deploy Rancher Workloads": { "message": "Deploy Rancher Workloads", @@ -283,9 +283,9 @@ "message": "Best Practices", "description": "The label for category Best Practices in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Rancher Manager Architecture": { - "message": "Rancher Manager Architecture", - "description": "The label for category Rancher Manager Architecture in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Rancher Architecture": { + "message": "Rancher Architecture", + "description": "The label for category Rancher Architecture in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Cluster Configuration": { "message": "Cluster Configuration", diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.json b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.json index d983a6cde6a..e5408e6ab91 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.json +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.json @@ -15,9 +15,9 @@ "message": "Quick Start Guides", "description": "The label for category Quick Start Guides in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Deploy Rancher Manager": { - "message": "Deploy Rancher Manager", - "description": "The label for category Deploy Rancher Manager in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Deploy Rancher": { + "message": "Deploy Rancher", + "description": "The label for category Deploy Rancher in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Deploy Rancher Workloads": { "message": "Deploy Rancher Workloads", @@ -251,9 +251,9 @@ "message": "Rancher-Managed Clusters", "description": "The label for category Rancher-Managed Clusters in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Rancher Manager Architecture": { - "message": "Rancher Manager Architecture", - "description": "The label for category Rancher Manager Architecture in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Rancher Architecture": { + "message": "Rancher Architecture", + "description": "The label for category Rancher Architecture in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Cluster Configuration": { "message": "Cluster Configuration", diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.6.json b/i18n/zh/docusaurus-plugin-content-docs/version-2.6.json index f279a6bb5c0..d0d87d122c7 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.6.json +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.6.json @@ -11,9 +11,9 @@ "message": "快速入门指南", "description": "The label for category Quick Start Guides in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Deploy Rancher Manager": { - "message": "部署 Rancher Manager", - "description": "The label for category Deploy Rancher Manager in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Deploy Rancher": { + "message": "部署 Rancher", + "description": "The label for category Deploy Rancher in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Deploy Rancher Workloads": { "message": "部署 Rancher 工作负载", @@ -243,9 +243,9 @@ "message": "Rancher 管理的集群", "description": "The label for category Rancher-Managed Clusters in sidebar tutorialSidebar" }, - "sidebar.tutorialSidebar.category.Rancher Manager Architecture": { - "message": "Rancher Manager 架构", - "description": "The label for category Rancher Manager Architecture in sidebar tutorialSidebar" + "sidebar.tutorialSidebar.category.Rancher Architecture": { + "message": "Rancher 架构", + "description": "The label for category Rancher Architecture in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Cluster Configuration": { "message": "集群配置", diff --git a/sidebars.js b/sidebars.js index dcc34d8d199..d2e86d8095d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -35,7 +35,7 @@ const sidebars = { items: [ { type: 'category', - label: 'Deploy Rancher Manager', + label: 'Deploy Rancher', link: { type: 'doc', id: "pages-for-subheaders/deploy-rancher-manager", @@ -846,7 +846,7 @@ const sidebars = { }, { type: 'category', - label: 'Rancher Manager Architecture', + label: 'Rancher Architecture', link: { type: 'doc', id: "pages-for-subheaders/rancher-manager-architecture", diff --git a/versioned_docs/version-2.0-2.4/getting-started/introduction/what-are-divio-docs.md b/versioned_docs/version-2.0-2.4/getting-started/introduction/what-are-divio-docs.md index d2030a8ac76..5bca251af2c 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/introduction/what-are-divio-docs.md +++ b/versioned_docs/version-2.0-2.4/getting-started/introduction/what-are-divio-docs.md @@ -2,17 +2,17 @@ title: What Are Divio Docs? --- -The [Divio documentation system](https://documentation.divio.com/) is a software documentation paradigm that is based on functionality and the premise that the best documentation is specific, concise, and purposeful. Divio traditionally consists of four main categories: tutorials, how-to guides, reference guides, and explanations. +The [Divio documentation system](https://documentation.divio.com/) is a software documentation paradigm that is based on functionality and the premise that the best documentation is specific, concise, and purposeful. Divio traditionally consists of four main categories: tutorials, how-to guides, reference guides, and explanations. -In our docs, we have used this guideline to craft a unique set of docs which include [getting started](../../getting-started.md), [how-to guides](../../how-to-guides.md) (including [new](../../pages-for-subheaders/new-user-guides.md) and [advanced user guides](../../pages-for-subheaders/advanced-user-guides.md)), [reference guides](../../reference-guides.md), [explanations](../../explanations.md), an [FAQ section](../../faq.md), [troubleshooting tips](../../troubleshooting.md), and the ability to [contribute to Rancher](../../contribute-to-rancher.md). +In our docs, we have used this guideline to craft a unique set of docs which include [getting started](../../getting-started.md), [how-to guides](../../how-to-guides.md) (including [new](../../pages-for-subheaders/new-user-guides.md) and [advanced user guides](../../pages-for-subheaders/advanced-user-guides.md)), [reference guides](../../reference-guides.md), [explanations](../../explanations.md), an [FAQ section](../../faq.md), [troubleshooting tips](../../troubleshooting.md), and the ability to [contribute to Rancher](../../contribute-to-rancher.md). - [Getting Started](#getting-started) - [How-to Guides](#how-to-guides) - - [New User Guides](#new-user-guides) +[New User Guides](#new-user-guides) - [Advanced User Guides](#advanced-user-guides) - [Reference Guides](#reference-guides) - [Explanations](#explanations) - - [Integrations in Rancher](#integrations-in-rancher) + - [Integrations in Rancher](#integrations-in-rancher) - [Other Docs Categories](#other-docs-categories) - [FAQ](#faq) - [Troubleshooting](#troubleshooting) @@ -31,9 +31,9 @@ Please see the [introduction](../../pages-for-subheaders/introduction.md), [quic ## How-to Guides -How-to guides serve to describe practical steps for users to accomplish some task. In Rancher, we break down how-to guides further into [new user guides](#new-user-guides) and [advanced user guides](#advanced-user-guides). +[new user guides](#new-user-guides) -### New User Guides +### New User Guides New user guides, also known as tutorials, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". @@ -55,11 +55,11 @@ A good example of an advanced user guide can be found [here](../../how-to-guides Reference guides are technical descriptions of processes or products that users can study. Reference guides are designed to be "information-oriented" and their primary function is to describe. -These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. +These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. The users who utilize reference guides are knowledgeable with the Rancher product as well as how to use it. They will benefit from detailed descriptions of something to be used when needing to refer to specifics of usage. -Good examples of Rancher reference guides would be the [Rancher Manager architecture](../../pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](../../pages-for-subheaders/cluster-configuration.md). +Good examples of Rancher reference guides would be the [Rancher architecture](../../pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](../../pages-for-subheaders/cluster-configuration.md). ## Explanations @@ -71,7 +71,7 @@ For our new docs, we are working to build up this section as most of our previou ### Integrations in Rancher -Over time, Rancher has accrued several products and projects that have been integrated into the Rancher UI. To assist users in learning more about these integrations, this subsection has been added under **Explanations**. +Over time, Rancher has accrued several products and projects that have been integrated into the Rancher UI. To assist users in learning more about these integrations, this subsection has been added under **Explanations**. Examples of some of these integrations are [Istio](../../pages-for-subheaders/istio.md) and [CIS Scans](../../pages-for-subheaders/cis-scans.md). @@ -91,9 +91,9 @@ We work to continually add to and enhance this section; check back frequently fo ### Contribute to Rancher -The Rancher Manager documentation is always a work-in-progress; the docs work best when being constantly examined, updated, and improved upon. To do this more effectively, we call upon the community to assist us. +The Rancher documentation is always a work-in-progress; the docs work best when being constantly examined, updated, and improved upon. To do this more effectively, we call upon the community to assist us. -This [contributing to Rancher section](../../contribute-to-rancher.md) will instruct users on the repositories used for Rancher, how to build the repositories, and what information is needed when filing an issue or creating a pull request. +This [contributing to Rancher section](../../contribute-to-rancher.md) will instruct users on the repositories used for Rancher, how to build the repositories, and what information is needed when filing an issue or creating a pull request. We review all contributions frequently and will provide feedback to contributors promptly. @@ -103,10 +103,10 @@ You may have noticed that within the confines of each category - new user guides ## New Structure Goals -Our previous Rancher documentation focused on individual features and topics; the new Divio paradigm prioritizes function and cohesion. +Our previous Rancher documentation focused on individual features and topics; the new Divio paradigm prioritizes function and cohesion. Because the previous docs structure was not based on the Divio paradigm, not every doc as it is written currently will fall neatly into a user guide or a reference, for example. Some docs may include elements of several kind of documentation functions. -As such, we have worked to move our existing documentation into the new paradigm based on each doc's function. Moving forward, we will be creating, rewriting, and reshaping our docs as needed to more closely align with the Divio structure, purpose, and its design concepts. +As such, we have worked to move our existing documentation into the new paradigm based on each doc's function. Moving forward, we will be creating, rewriting, and reshaping our docs as needed to more closely align with the Divio structure, purpose, and its design concepts. Ultimately, the finished product will much more cohesively and effectively assist our users by emphasizing functionality over individual topic or feature-based docs. \ No newline at end of file diff --git a/versioned_docs/version-2.0-2.4/pages-for-subheaders/introduction.md b/versioned_docs/version-2.0-2.4/pages-for-subheaders/introduction.md index 8fcb5797ed1..a3dd4562538 100644 --- a/versioned_docs/version-2.0-2.4/pages-for-subheaders/introduction.md +++ b/versioned_docs/version-2.0-2.4/pages-for-subheaders/introduction.md @@ -2,4 +2,4 @@ title: Introduction --- -The [overview](../getting-started/introduction/overview.md) will discuss Rancher's features, capabilities, and how it makes running Kubernetes easy. The guide to the [new Rancher Manager docs structure, Divio,](../getting-started/introduction/what-are-divio-docs.md) will explain more about the updated look and function of our docs. \ No newline at end of file +The [overview](../getting-started/introduction/overview.md) will discuss Rancher's features, capabilities, and how it makes running Kubernetes easy. The guide to the [new Rancher docs structure, Divio,](../getting-started/introduction/what-are-divio-docs.md) will explain more about the updated look and function of our docs. \ No newline at end of file diff --git a/versioned_docs/version-2.0-2.4/reference-guides.md b/versioned_docs/version-2.0-2.4/reference-guides.md index b16f02853c5..659b1c02e63 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides.md +++ b/versioned_docs/version-2.0-2.4/reference-guides.md @@ -4,8 +4,8 @@ title: Reference Guides **Reference guides** are technical descriptions of processes or products that users can study. Reference guides are designed to be "information-oriented" and their primary function is to describe. -These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. +These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. The users who utilize reference guides are knowledgeable with the Rancher product as well as how to use it. They will benefit from detailed descriptions of something to be used when needing to refer to specifics of usage. -Good examples of Rancher reference guides would be the [Rancher Manager architecture](./pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](./pages-for-subheaders/cluster-configuration.md). \ No newline at end of file +Good examples of Rancher reference guides would be the [Rancher architecture](./pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](./pages-for-subheaders/cluster-configuration.md). \ No newline at end of file diff --git a/versioned_docs/version-2.5/getting-started/introduction/what-are-divio-docs.md b/versioned_docs/version-2.5/getting-started/introduction/what-are-divio-docs.md index 0d6e4f3bf0c..7a924263a8b 100644 --- a/versioned_docs/version-2.5/getting-started/introduction/what-are-divio-docs.md +++ b/versioned_docs/version-2.5/getting-started/introduction/what-are-divio-docs.md @@ -2,17 +2,17 @@ title: What Are Divio Docs? --- -The [Divio documentation system](https://documentation.divio.com/) is a software documentation paradigm that is based on functionality and the premise that the best documentation is specific, concise, and purposeful. Divio traditionally consists of four main categories: tutorials, how-to guides, reference guides, and explanations. +The [Divio documentation system](https://documentation.divio.com/) is a software documentation paradigm that is based on functionality and the premise that the best documentation is specific, concise, and purposeful. Divio traditionally consists of four main categories: tutorials, how-to guides, reference guides, and explanations. -In our docs, we have used this guideline to craft a unique set of docs which include [getting started](../../getting-started.md), [how-to guides](../../how-to-guides.md) (including [new](../../pages-for-subheaders/new-user-guides.md) and [advanced user guides](../../pages-for-subheaders/advanced-user-guides.md)), [reference guides](../../reference-guides.md), [explanations](../../explanations.md), an [FAQ section](../../faq.md), [troubleshooting tips](../../troubleshooting.md), and the ability to [contribute to Rancher](../../contribute-to-rancher.md). +In our docs, we have used this guideline to craft a unique set of docs which include [getting started](../../getting-started.md), [how-to guides](../../how-to-guides.md) (including [new](../../pages-for-subheaders/new-user-guides.md) and [advanced user guides](../../pages-for-subheaders/advanced-user-guides.md)), [reference guides](../../reference-guides.md), [explanations](../../explanations.md), an [FAQ section](../../faq.md), [troubleshooting tips](../../troubleshooting.md), and the ability to [contribute to Rancher](../../contribute-to-rancher.md). - [Getting Started](#getting-started) - [How-to Guides](#how-to-guides) - - [New User Guides](#new-user-guides) +[New User Guides](#new-user-guides) - [Advanced User Guides](#advanced-user-guides) - [Reference Guides](#reference-guides) - [Explanations](#explanations) - - [Integrations in Rancher](#integrations-in-rancher) + - [Integrations in Rancher](#integrations-in-rancher) - [Other Docs Categories](#other-docs-categories) - [FAQ](#faq) - [Troubleshooting](#troubleshooting) @@ -31,9 +31,9 @@ Please see the [introduction](../../pages-for-subheaders/introduction.md), [quic ## How-to Guides -How-to guides serve to describe practical steps for users to accomplish some task. In Rancher, we break down how-to guides further into [new user guides](#new-user-guides) and [advanced user guides](#advanced-user-guides). +[new user guides](#new-user-guides) -### New User Guides +### New User Guides New user guides, also known as tutorials, describe practical steps for users to follow in order to complete some concrete action. These docs are known as "learning-oriented" docs in which users learn by "doing". @@ -55,11 +55,11 @@ A good example of an advanced user guide can be found [here](../../how-to-guides Reference guides are technical descriptions of processes or products that users can study. Reference guides are designed to be "information-oriented" and their primary function is to describe. -These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. +These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. The users who utilize reference guides are knowledgeable with the Rancher product as well as how to use it. They will benefit from detailed descriptions of something to be used when needing to refer to specifics of usage. -Good examples of Rancher reference guides would be the [Rancher Manager architecture](../../pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](../../pages-for-subheaders/cluster-configuration.md). +Good examples of Rancher reference guides would be the [Rancher architecture](../../pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](../../pages-for-subheaders/cluster-configuration.md). ## Explanations @@ -71,7 +71,7 @@ For our new docs, we are working to build up this section as most of our previou ### Integrations in Rancher -Over time, Rancher has accrued several products and projects that have been integrated into the Rancher UI. To assist users in learning more about these integrations, this subsection has been added under **Explanations**. +Over time, Rancher has accrued several products and projects that have been integrated into the Rancher UI. To assist users in learning more about these integrations, this subsection has been added under **Explanations**. Examples of some of these integrations are [Continuous Delivery with Fleet](../../pages-for-subheaders/fleet-gitops-at-scale.md) and [Monitoring and Alerting](../../pages-for-subheaders/monitoring-and-alerting.md). @@ -91,9 +91,9 @@ We work to continually add to and enhance this section; check back frequently fo ### Contribute to Rancher -The Rancher Manager documentation is always a work-in-progress; the docs work best when being constantly examined, updated, and improved upon. To do this more effectively, we call upon the community to assist us. +The Rancher documentation is always a work-in-progress; the docs work best when being constantly examined, updated, and improved upon. To do this more effectively, we call upon the community to assist us. -This [contributing to Rancher section](../../contribute-to-rancher.md) will instruct users on the repositories used for Rancher, how to build the repositories, and what information is needed when filing an issue or creating a pull request. +This [contributing to Rancher section](../../contribute-to-rancher.md) will instruct users on the repositories used for Rancher, how to build the repositories, and what information is needed when filing an issue or creating a pull request. We review all contributions frequently and will provide feedback to contributors promptly. @@ -103,10 +103,10 @@ You may have noticed that within the confines of each category - new user guides ## New Structure Goals -Our previous Rancher documentation focused on individual features and topics; the new Divio paradigm prioritizes function and cohesion. +Our previous Rancher documentation focused on individual features and topics; the new Divio paradigm prioritizes function and cohesion. Because the previous docs structure was not based on the Divio paradigm, not every doc as it is written currently will fall neatly into a user guide or a reference, for example. Some docs may include elements of several kind of documentation functions. -As such, we have worked to move our existing documentation into the new paradigm based on each doc's function. Moving forward, we will be creating, rewriting, and reshaping our docs as needed to more closely align with the Divio structure, purpose, and its design concepts. +As such, we have worked to move our existing documentation into the new paradigm based on each doc's function. Moving forward, we will be creating, rewriting, and reshaping our docs as needed to more closely align with the Divio structure, purpose, and its design concepts. Ultimately, the finished product will much more cohesively and effectively assist our users by emphasizing functionality over individual topic or feature-based docs. diff --git a/versioned_docs/version-2.5/pages-for-subheaders/introduction.md b/versioned_docs/version-2.5/pages-for-subheaders/introduction.md index 8fcb5797ed1..a3dd4562538 100644 --- a/versioned_docs/version-2.5/pages-for-subheaders/introduction.md +++ b/versioned_docs/version-2.5/pages-for-subheaders/introduction.md @@ -2,4 +2,4 @@ title: Introduction --- -The [overview](../getting-started/introduction/overview.md) will discuss Rancher's features, capabilities, and how it makes running Kubernetes easy. The guide to the [new Rancher Manager docs structure, Divio,](../getting-started/introduction/what-are-divio-docs.md) will explain more about the updated look and function of our docs. \ No newline at end of file +The [overview](../getting-started/introduction/overview.md) will discuss Rancher's features, capabilities, and how it makes running Kubernetes easy. The guide to the [new Rancher docs structure, Divio,](../getting-started/introduction/what-are-divio-docs.md) will explain more about the updated look and function of our docs. \ No newline at end of file diff --git a/versioned_docs/version-2.5/reference-guides.md b/versioned_docs/version-2.5/reference-guides.md index b16f02853c5..659b1c02e63 100644 --- a/versioned_docs/version-2.5/reference-guides.md +++ b/versioned_docs/version-2.5/reference-guides.md @@ -4,8 +4,8 @@ title: Reference Guides **Reference guides** are technical descriptions of processes or products that users can study. Reference guides are designed to be "information-oriented" and their primary function is to describe. -These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. +These docs may also include some usage steps in the course of description; however, their purpose is not to explain concepts nor to outline steps to achieve tasks. The users who utilize reference guides are knowledgeable with the Rancher product as well as how to use it. They will benefit from detailed descriptions of something to be used when needing to refer to specifics of usage. -Good examples of Rancher reference guides would be the [Rancher Manager architecture](./pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](./pages-for-subheaders/cluster-configuration.md). \ No newline at end of file +Good examples of Rancher reference guides would be the [Rancher architecture](./pages-for-subheaders/rancher-manager-architecture.md) and [cluster configuration guides](./pages-for-subheaders/cluster-configuration.md). \ No newline at end of file diff --git a/versioned_sidebars/version-2.0-2.4-sidebars.json b/versioned_sidebars/version-2.0-2.4-sidebars.json index a511ed12b3b..e4cd68fb815 100644 --- a/versioned_sidebars/version-2.0-2.4-sidebars.json +++ b/versioned_sidebars/version-2.0-2.4-sidebars.json @@ -32,7 +32,7 @@ "getting-started/quick-start-guides/cli", { "type": "category", - "label": "Deploy Rancher Manager", + "label": "Deploy Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/deploy-rancher-manager" @@ -915,7 +915,7 @@ }, { "type": "category", - "label": "Rancher Manager Architecture", + "label": "Rancher Architecture", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-manager-architecture" diff --git a/versioned_sidebars/version-2.5-sidebars.json b/versioned_sidebars/version-2.5-sidebars.json index 0d2db94e85f..4579266caa8 100644 --- a/versioned_sidebars/version-2.5-sidebars.json +++ b/versioned_sidebars/version-2.5-sidebars.json @@ -31,7 +31,7 @@ "items": [ { "type": "category", - "label": "Deploy Rancher Manager", + "label": "Deploy Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/deploy-rancher-manager" @@ -834,7 +834,7 @@ }, { "type": "category", - "label": "Rancher Manager Architecture", + "label": "Rancher Architecture", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-manager-architecture" diff --git a/versioned_sidebars/version-2.6-sidebars.json b/versioned_sidebars/version-2.6-sidebars.json index ed21b6f5ce3..8726fb3fa42 100644 --- a/versioned_sidebars/version-2.6-sidebars.json +++ b/versioned_sidebars/version-2.6-sidebars.json @@ -16,7 +16,7 @@ "items": [ { "type": "category", - "label": "Deploy Rancher Manager", + "label": "Deploy Rancher", "link": { "type": "doc", "id": "pages-for-subheaders/deploy-rancher-manager" @@ -807,7 +807,7 @@ }, { "type": "category", - "label": "Rancher Manager Architecture", + "label": "Rancher Architecture", "link": { "type": "doc", "id": "pages-for-subheaders/rancher-manager-architecture"