Skip to content

Commit

Permalink
Describe ways to improve the documentation (#846)
Browse files Browse the repository at this point in the history
* in progress

* Describe ways to improve the documentation

* Update versioned docs
  • Loading branch information
visortelle committed Mar 14, 2024
1 parent 0fea6db commit d6fffb9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
11 changes: 6 additions & 5 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand All @@ -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!
***
Expand Down
9 changes: 5 additions & 4 deletions versioned_docs/version-3.0.x/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
***
Expand Down
9 changes: 5 additions & 4 deletions versioned_docs/version-3.2.x/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
***
Expand Down

0 comments on commit d6fffb9

Please sign in to comment.