From d6fffb90ea52df0fac31d4073064663ca030a856 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kiryl=20Valkovich=20=F0=9F=9B=B8?= Date: Thu, 14 Mar 2024 13:21:29 +0400 Subject: [PATCH] Describe ways to improve the documentation (#846) * in progress * Describe ways to improve the documentation * Update versioned docs --- docs/about.md | 11 ++++++----- versioned_docs/version-3.0.x/about.md | 9 +++++---- versioned_docs/version-3.2.x/about.md | 9 +++++---- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/about.md b/docs/about.md index abe5db87e05f..26be534ef951 100644 --- a/docs/about.md +++ b/docs/about.md @@ -15,7 +15,7 @@ import { docUrl } from "@site/src/utils/index"; This portal holds a variety of topics, tutorials, guides, and reference material to help you work with Pulsar. -## Choose your path.... +## Choose your path Select one of the content blocks below to begin your Pulsar journey. If you ... * Are new to Pulsar, start with **About Pulsar** to learn about features and concepts. * Want to jump to the quickstart, select **Get Started**. @@ -41,13 +41,14 @@ As you probably know, we are working on a new user experience for our documentat ## Help Improve These Documents *** -You'll notice an Edit button at the bottom and top of each page. Click it to open a landing page with instructions for requesting changes to posted documents. These are your resources. Participation is not only welcomed – it's essential! +Participation is not only welcomed – it's essential! -:::tip +📚 There are multiple ways you can help to make the Pulsar documentation better: -For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](pathname:///contribute/document-intro). +- **Submit a Pull Request**: You'll find the "Edit this page" link at the bottom of each page. Click the link and follow the [Pulsar Documentation Contribution Guide](pathname:///contribute/document-intro). -::: +- **💡 Suggest changes**: If you found a mistake, the documentation is incomplete, but for any reason you're not ready to submit a PR, or you have any other suggestion, please click the appropriate link at the top right of any documentation page. +- **🛟 Get support**: If something isn't clear for you in the documentation, or you have general questions about Pulsar, you can ask the community by clicking the appropriate link at the top right of any documentation page. This way you will help people searching for the answer to this question in the future after someone from the community answers your question. ## Join the Community! *** diff --git a/versioned_docs/version-3.0.x/about.md b/versioned_docs/version-3.0.x/about.md index 8318e85d357f..7797cc93fa2f 100644 --- a/versioned_docs/version-3.0.x/about.md +++ b/versioned_docs/version-3.0.x/about.md @@ -40,13 +40,14 @@ As you probably know, we are working on a new user experience for our documentat ## Help Improve These Documents *** -You'll notice an Edit button at the bottom and top of each page. Click it to open a landing page with instructions for requesting changes to posted documents. These are your resources. Participation is not only welcomed – it's essential! +Participation is not only welcomed – it's essential! -:::tip +📚 There are multiple ways you can help to make the Pulsar documentation better: -For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](pathname:///contribute/document-intro). +- **Submit a Pull Request**: You'll find the "Edit this page" link at the bottom of each page. Click the link and follow the [Pulsar Documentation Contribution Guide](pathname:///contribute/document-intro). -::: +- **💡 Suggest changes**: If you found a mistake, the documentation is incomplete, but for any reason you're not ready to submit a PR, or you have any other suggestion, please click the appropriate link at the top right of any documentation page. +- **🛟 Get support**: If something isn't clear for you in the documentation, or you have general questions about Pulsar, you can ask the community by clicking the appropriate link at the top right of any documentation page. This way you will help people searching for the answer to this question in the future after someone from the community answers your question. ## Join the Community! *** diff --git a/versioned_docs/version-3.2.x/about.md b/versioned_docs/version-3.2.x/about.md index abe5db87e05f..a75f88b233b4 100644 --- a/versioned_docs/version-3.2.x/about.md +++ b/versioned_docs/version-3.2.x/about.md @@ -41,13 +41,14 @@ As you probably know, we are working on a new user experience for our documentat ## Help Improve These Documents *** -You'll notice an Edit button at the bottom and top of each page. Click it to open a landing page with instructions for requesting changes to posted documents. These are your resources. Participation is not only welcomed – it's essential! +Participation is not only welcomed – it's essential! -:::tip +📚 There are multiple ways you can help to make the Pulsar documentation better: -For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](pathname:///contribute/document-intro). +- **Submit a Pull Request**: You'll find the "Edit this page" link at the bottom of each page. Click the link and follow the [Pulsar Documentation Contribution Guide](pathname:///contribute/document-intro). -::: +- **💡 Suggest changes**: If you found a mistake, the documentation is incomplete, but for any reason you're not ready to submit a PR, or you have any other suggestion, please click the appropriate link at the top right of any documentation page. +- **🛟 Get support**: If something isn't clear for you in the documentation, or you have general questions about Pulsar, you can ask the community by clicking the appropriate link at the top right of any documentation page. This way you will help people searching for the answer to this question in the future after someone from the community answers your question. ## Join the Community! ***