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 09:52:15 UTC
[GitHub] [pulsar-site] tisonkun commented on a diff in pull request #322: [improve][doc] add workflow for previewing content
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