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/10/20 07:28:45 UTC
[GitHub] [pulsar-site] SignorMercurio opened a new pull request, #259: Improve TOC style, docs for CLI tools and directory structure
SignorMercurio opened a new pull request, #259:
URL: https://github.com/apache/pulsar-site/pull/259
1. Show entire left TOC, and make it collapsible
2. Fix 404 issue of CLI tools page
3. Unify behavior of docs for CLI tools
4. Remove broker-tool and add pulsar-shell
5. Remove `_sidebar.md` in each directory and add it in each version's directory
6. Move `$WEBSITE/docsify` to `$WEBSITE/static/reference` so that we can preview it together with the main site with `yarn start`
7. Add missing release notes
8. Move docs for CLI tools to this repo
9. Minor fixes and rewords
--
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] urfreespace merged pull request #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
urfreespace merged PR #259:
URL: https://github.com/apache/pulsar-site/pull/259
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#issuecomment-1315357726
I just noticed that we should still generate CLI references for each major release. Is it correct?
--
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] SignorMercurio commented on a diff in pull request #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1005213831
##########
site2/website-next/release-notes/versioned/pulsar-cs-2.4.1.md:
##########
@@ -0,0 +1,9 @@
+---
Review Comment:
These are newly added, not modified. They are added because they are missing.
--
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] urfreespace commented on a diff in pull request #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
urfreespace commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1007527592
##########
site2/tools/build-site.sh:
##########
@@ -50,11 +50,8 @@ bash scripts/split-version-build.sh $@
cd "$WEBSITE_DIR"
CONTENT_DIR="$GEN_SITE_DIR"/content
-
-rm -rf "$CONTENT_DIR"
-mkdir -p "$CONTENT_DIR"
-mkdir -p "$CONTENT_DIR"/reference
-rsync -a ./docsify/ "$CONTENT_DIR"/reference
+rm -rf "$CONTENT_DIR" && mkdir -p "$CONTENT_DIR"
+cp -R static/reference "$CONTENT_DIR"
rsync -a ./build/ "$CONTENT_DIR"
Review Comment:
yes, thanks for @tisonkun, could you pls do a test with this code from @tisonkun's suggestion? @SignorMercurio
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1005217665
##########
site2/website-next/release-notes/versioned/pulsar-cs-2.4.1.md:
##########
@@ -0,0 +1,9 @@
+---
Review Comment:
Is their missing related to this patch? I don't know why they're missed in the first place and why we couple these changes in the patch to resolve the location of reference docs.
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#issuecomment-1294406827
LGTM from the requirement side.
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1007510111
##########
site2/website-next/release-notes/versioned/pulsar-cs-2.4.1.md:
##########
@@ -0,0 +1,9 @@
+---
Review Comment:
So where do you add these files from?
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#issuecomment-1288736359
I notice that after #261 merged, static files under `$WEBSITE/static/reference` aren't released. It's weird and should not happen. Otherwise, that we're moving the docsify files here becomes meaningless.
cc @urfreespace any ideas?
--
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] urfreespace commented on pull request #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
urfreespace commented on PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#issuecomment-1289844341
> I notice that after #261 merged, static files under `$WEBSITE/static/reference` aren't released (for example, the `.htaccess` file). It's weird and should not happen. Otherwise, that we're moving the docsify files here becomes meaningless.
>
> cc @urfreespace any ideas?
>
> UPDATE: Well. I notice that only part of files under `$WEBSITE/static` are manually moved. Then it's not an issue for this patch.
fixed with https://github.com/apache/pulsar-site/pull/263
--
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] SignorMercurio commented on a diff in pull request #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1005220705
##########
site2/website-next/release-notes/versioned/pulsar-cs-2.4.1.md:
##########
@@ -0,0 +1,9 @@
+---
Review Comment:
No, I also have no idea why these docs are missing. I added these to avoid 404 links in the Release Notes page.
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1007509569
##########
site2/tools/build-site.sh:
##########
@@ -50,11 +50,8 @@ bash scripts/split-version-build.sh $@
cd "$WEBSITE_DIR"
CONTENT_DIR="$GEN_SITE_DIR"/content
-
-rm -rf "$CONTENT_DIR"
-mkdir -p "$CONTENT_DIR"
-mkdir -p "$CONTENT_DIR"/reference
-rsync -a ./docsify/ "$CONTENT_DIR"/reference
+rm -rf "$CONTENT_DIR" && mkdir -p "$CONTENT_DIR"
+cp -R static/reference "$CONTENT_DIR"
rsync -a ./build/ "$CONTENT_DIR"
Review Comment:
`cp -R` seems work differently to the standard on the CI env. Use `rsync -a` correctly stably copy all files (including hidden files) recursively.
Besides, since we move references under the `static` folder, there's no need to special handle them.
Thus, this code snippet can be written as:
```bash
rm -rf "$CONTENT_DIR"
mkdir -p "$CONTENT_DIR"
rsync -a ./build/ "$CONTENT_DIR"
```
@urfreespace @SignorMercurio please check.
--
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] SignorMercurio commented on a diff in pull request #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1007584475
##########
site2/tools/build-site.sh:
##########
@@ -50,11 +50,8 @@ bash scripts/split-version-build.sh $@
cd "$WEBSITE_DIR"
CONTENT_DIR="$GEN_SITE_DIR"/content
-
-rm -rf "$CONTENT_DIR"
-mkdir -p "$CONTENT_DIR"
-mkdir -p "$CONTENT_DIR"/reference
-rsync -a ./docsify/ "$CONTENT_DIR"/reference
+rm -rf "$CONTENT_DIR" && mkdir -p "$CONTENT_DIR"
+cp -R static/reference "$CONTENT_DIR"
rsync -a ./build/ "$CONTENT_DIR"
Review Comment:
Sure, I'll have a try and update the script.
--
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 #259: Improve TOC style, docs for CLI tools and directory structure
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #259:
URL: https://github.com/apache/pulsar-site/pull/259#discussion_r1004634538
##########
site2/website-next/release-notes/versioned/pulsar-cs-2.4.1.md:
##########
@@ -0,0 +1,9 @@
+---
Review Comment:
Why do we need to make changes on these files (under `release-notes/versioned`.
--
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