You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/08/26 13:57:08 UTC
[GitHub] [pulsar] D-2-Ed opened a new pull request, #17301: [Doc] Added explanations for documentation landing page
D-2-Ed opened a new pull request, #17301:
URL: https://github.com/apache/pulsar/pull/17301
Doc updates and navigational support to improve user experience.
### Motivation
Improve user experience by adding "paths" and providing context.
### Modifications
Context updates for each content block. Describes where the user should start.
### Verifying this change
This is a doc change and does not require CI checks or test coverage.
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `doc-not-needed`
(Please explain why)
- [ ] `doc`
(Your PR contains doc changes)
- [X] `doc-complete`
(Docs have been already added)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1231030228
@D-2-Ed could you please help rebase your branch? Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #17301:
URL: https://github.com/apache/pulsar/pull/17301
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1229623195
> @Huanli-Meng - Can you approve this PR?
@D-2-Ed Done. PTAL, thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1230322378
I think we can merge this patch with one more committer's approval.
cc @Anonymitaet @dave2wave
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] D-2-Ed commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
D-2-Ed commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1230560953
@Anonymitaet - can you approve? Thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] D-2-Ed commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
D-2-Ed commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1228893585
@Huanli-Meng - Can you approve this PR?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] D-2-Ed commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
D-2-Ed commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1230318466
Is there another step for these text changes?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Huanli-Meng commented on a diff in pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
Huanli-Meng commented on code in PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#discussion_r956817418
##########
site2/docs/about.md:
##########
@@ -10,21 +10,27 @@ import BlockLink from "@site/src/components/BlockLink";
import { docUrl } from "@site/src/utils/index";
-# Welcome to the doc portal!
+# Welcome to the Apache Pulsar documentation portal
***
-This portal holds a variety of support documents to help you work with Pulsar . If you’re a beginner, there are tutorials and explainers to help you understand Pulsar and how it works.
+This portal holds a variety of topics, tutorials, guides, and reference material to help you work with Pulsar.
-If you’re an experienced coder, review this page to learn the easiest way to access the specific content you’re looking for.
+## 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**.
+* Are an operator responsible for architecting and supporting Apache Pulsar. start with **Install, Deploy, Upgrade**.
+* Are a developer who wants to master Apache Pulsar, select **Pulsar for Developers**.
+* If you just want to try out Pulsar, select **How To** for access to the "hello world" tutorial.
Review Comment:
```suggestion
* Want to try out Pulsar, select **How To** for access to the "hello world" tutorial.
```
##########
site2/docs/about.md:
##########
@@ -10,21 +10,27 @@ import BlockLink from "@site/src/components/BlockLink";
import { docUrl } from "@site/src/utils/index";
-# Welcome to the doc portal!
+# Welcome to the Apache Pulsar documentation portal
***
-This portal holds a variety of support documents to help you work with Pulsar . If you’re a beginner, there are tutorials and explainers to help you understand Pulsar and how it works.
+This portal holds a variety of topics, tutorials, guides, and reference material to help you work with Pulsar.
-If you’re an experienced coder, review this page to learn the easiest way to access the specific content you’re looking for.
+## 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**.
+* Are an operator responsible for architecting and supporting Apache Pulsar. start with **Install, Deploy, Upgrade**.
+* Are a developer who wants to master Apache Pulsar, select **Pulsar for Developers**.
+* If you just want to try out Pulsar, select **How To** for access to the "hello world" tutorial.
+* If you are an experienced Pulsar coder looking for API, metrics, or configuration documentation, go to **Reference**.
Review Comment:
```suggestion
* An experienced Pulsar coder looking for API, metrics, or configuration documentation, go to **Reference**.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on pull request #17301: [Doc] Added explanations for documentation landing page
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #17301:
URL: https://github.com/apache/pulsar/pull/17301#issuecomment-1229626456
@D-2-Ed you may tag this PR as `doc` instead of `doc-complete` :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org