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/12/09 02:14:44 UTC
[GitHub] [pulsar-site] Anonymitaet opened a new pull request, #322: [improve][doc] add workflow for previewing content
Anonymitaet opened a new pull request, #322:
URL: https://github.com/apache/pulsar-site/pull/322
The preview looks good:
<img width="1674" alt="image" src="https://user-images.githubusercontent.com/50226895/206608329-e9fac144-893a-403b-a4f6-6a1500e1fd1f.png">
<img width="1650" alt="image" src="https://user-images.githubusercontent.com/50226895/206608481-551175c3-1c9f-4fd4-ab7e-9bdc2ce27d34.png">
--
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-site] Anonymitaet commented on pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#issuecomment-1344195202
@tisonkun
>Let's use admonitions consistently.
Nice catch! Done.
>But we may unindent for both this tip and the following screenshot?
I indent them with 2 spaces as they belong to the step 2.
<img width="999" alt="image" src="https://user-images.githubusercontent.com/50226895/206692860-962368a2-910a-4370-8438-924e50abe7b3.png">
This is the corresponding preview:
<img width="1818" alt="image" src="https://user-images.githubusercontent.com/50226895/206693208-95d8f154-130c-46c4-a05a-5b9ec44059ec.png">
--
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-site] tisonkun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#discussion_r1044278342
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,13 +37,21 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
sh start.sh
- # Preview historical versions
- sh start.sh [<version-number> ...]
+
+ # Preview changes on a specific version version
+ sh start.sh 2.10.x
+
+ # Preview changes on multiple versions
+ sh start.sh 2.10.x 2.9.x ...
```
+
+ By default, a browser window will open at http://localhost:3000 to show the changes.
-3. By default, a browser window will open at http://localhost:3000 to show the changes.
+ > **Tip**
+ >
+ > If you want to preview changes on `master`, change the URL to `http://localhost:3000/docs/next`.
Review Comment:
The original content seems also rendered wrongly:
<img width="1051" alt="image" src="https://user-images.githubusercontent.com/18818196/206675530-05168131-5f83-45f0-892b-99c303bd4ad3.png">
Please preview locally :)
--
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-site] Anonymitaet commented on pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#issuecomment-1344084637
@tisonkun @momo-jun I've updated based on your comments, PTAL, thank you!
--
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-site] tisonkun commented on pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#issuecomment-1344232161
@Anonymitaet It seems that you don't push your local commits to the remote branch :)
--
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-site] tisonkun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#discussion_r1044272523
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,13 +37,21 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
Review Comment:
```suggestion
# Preview changes on latest stable version
```
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,13 +37,21 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
sh start.sh
- # Preview historical versions
- sh start.sh [<version-number> ...]
+
+ # Preview changes on a specific version version
+ sh start.sh 2.10.x
+
+ # Preview changes on multiple versions
+ sh start.sh 2.10.x 2.9.x ...
```
+
+ By default, a browser window will open at http://localhost:3000 to show the changes.
-3. By default, a browser window will open at http://localhost:3000 to show the changes.
+ > **Tip**
+ >
+ > If you want to preview changes on `master`, change the URL to `http://localhost:3000/docs/next`.
Review Comment:
```suggestion
:::tip
If you want to preview changes on `master`, change the URL to `http://localhost:3000/docs/next`.
:::
```
Let's use admonitions consistently. Also IIRC the admonitions rendering will fail if leading idents exist.
--
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-site] tisonkun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#discussion_r1044280681
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,13 +37,21 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
sh start.sh
- # Preview historical versions
- sh start.sh [<version-number> ...]
+
+ # Preview changes on a specific version version
+ sh start.sh 2.10.x
+
+ # Preview changes on multiple versions
+ sh start.sh 2.10.x 2.9.x ...
```
+
+ By default, a browser window will open at http://localhost:3000 to show the changes.
-3. By default, a browser window will open at http://localhost:3000 to show the changes.
+ > **Tip**
+ >
+ > If you want to preview changes on `master`, change the URL to `http://localhost:3000/docs/next`.
Review Comment:
Emmm...It seems a two-space indent can be rendered properly:
<img width="1728" alt="image" src="https://user-images.githubusercontent.com/18818196/206676022-e879dc28-509f-473a-8e1b-a28dafd89511.png">
But we may unindent for both this tip and the following screenshot?
--
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-site] momo-jun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#discussion_r1044050212
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,14 +37,22 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
sh start.sh
- # Preview historical versions
- sh start.sh [<version-number> ...]
+
+ # Preview changes on a specific version version
+ sh start.sh 2.10.x
+
+ # Preview changes on multiple versions
+ sh start.sh 2.10.x 2.9.x ...
```
3. By default, a browser window will open at http://localhost:3000 to show the changes.
Review Comment:
Suggest removing the numbering `3` here. It's the result of step 2, not user's behavior.
--
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-site] tisonkun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#discussion_r1044273218
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,13 +37,21 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
sh start.sh
- # Preview historical versions
- sh start.sh [<version-number> ...]
+
+ # Preview changes on a specific version version
+ sh start.sh 2.10.x
+
+ # Preview changes on multiple versions
+ sh start.sh 2.10.x 2.9.x ...
```
+
+ By default, a browser window will open at http://localhost:3000 to show the changes.
-3. By default, a browser window will open at http://localhost:3000 to show the changes.
+ > **Tip**
+ >
+ > If you want to preview changes on `master`, change the URL to `http://localhost:3000/docs/next`.
Review Comment:
```suggestion
:::tip
If you want to preview changes on `master`, change the URL to `http://localhost:3000/docs/next`.
:::
```
Let's use admonitions consistently. Also IIRC the admonitions rendering will fail if leading indents exist.
--
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-site] Anonymitaet commented on pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#issuecomment-1344943360
@tisonkun Ah! Sorry, my bad. Already pushed.
--
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-site] tisonkun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#discussion_r1044948668
##########
site2/website-next/contribute/document-preview.md:
##########
@@ -37,15 +37,25 @@ Follow these steps to preview documentation changes on the **master** branch.
2. Run the following command to preview changes:
```bash
- # Preview the next version
+ # Preview changes on latest stable version
Review Comment:
```suggestion
# Preview changes on latest stable version
```
--
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-site] tisonkun merged pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
tisonkun merged PR #322:
URL: https://github.com/apache/pulsar-site/pull/322
--
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-site] Anonymitaet commented on pull request #322: [improve][doc] add workflow for previewing content
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #322:
URL: https://github.com/apache/pulsar-site/pull/322#issuecomment-1343749721
cc @momo-jun @DaveDuggins @D-2-Ed
--
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