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/12 07:04:06 UTC
[GitHub] [pulsar] tisonkun opened a new issue, #18014: [Doc] Generate document depending on main repo during sync
tisonkun opened a new issue, #18014:
URL: https://github.com/apache/pulsar/issues/18014
### Search before asking
- [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar.
### What issue do you find in Pulsar docs?
Currently, we build swagger files and config references on the site build stage. It prevents developers to preview the website smoothly.
### What is your suggestion?
I suggest we generate swagger files and config references during the sync stage and put generated files under `static` folder relate to the root path of docusaurus framework. So that we can properly preview the website fully.
### Any reference?
Related files:
* site2/tools/build-site.sh
* site2/tools/docker-build-site.sh
* site2/tools/pulsar-admin-doc-gen.sh
* site2/tools/pulsar-client-doc-gen.sh
* site2/tools/pulsar-perf-doc-gen.sh
* site2/tools/pulsar-doc-gen.sh
* site2/tools/pulsar-config-doc-gen.sh
* site2/website-next/scripts/split-swagger-by-version.js
* .github/workflows/ci-pulsar-website-docs-sync.yaml
* .github/workflows/ci-pulsar-website-next-build.yaml
cc @urfreespace @michaeljmarshall @Anonymitaet @SignorMercurio
### Are you willing to submit a PR?
- [ ] I'm willing to submit a 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.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on issue #18014: [Doc] Generate document depending on main repo during sync
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #18014:
URL: https://github.com/apache/pulsar/issues/18014#issuecomment-1312319093
The issue had no activity for 30 days, mark with Stale label.
--
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 issue #18014: [Doc] Generate document depending on main repo during sync
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #18014:
URL: https://github.com/apache/pulsar/issues/18014#issuecomment-1350494256
Closed as all subtasks done.
Now we have only the docs (version docs) and a few JSON files to sync, no prebuilt content in main repo nor heavy content generation logic in the build stage anymore.
--
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 issue #18014: [Doc] Generate document depending on main repo during sync
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #18014:
URL: https://github.com/apache/pulsar/issues/18014#issuecomment-1275697074
If we agree on the direction, we can achieve it in multiple subtasks concurrently; for example:
* those for swagger files;
* those for config files;
* those for release data;
* ...
--
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 closed issue #18014: [Doc] Generate document depending on main repo during sync
Posted by GitBox <gi...@apache.org>.
tisonkun closed issue #18014: [Doc] Generate document depending on main repo during sync
URL: https://github.com/apache/pulsar/issues/18014
--
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 issue #18014: [Doc] Generate document depending on main repo during sync
Posted by GitBox <gi...@apache.org>.
tisonkun commented on issue #18014:
URL: https://github.com/apache/pulsar/issues/18014#issuecomment-1350493077
@visortelle It's about how we display the REST API. I think it should have a separate issue to investigate how we generate this page from the swagger files and the [ReDoc](https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js) framework.
This issue is to avoid holding same files here and there so that developers can find it clumsy to update content.
--
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] visortelle commented on issue #18014: [Doc] Generate document depending on main repo during sync
Posted by GitBox <gi...@apache.org>.
visortelle commented on issue #18014:
URL: https://github.com/apache/pulsar/issues/18014#issuecomment-1339170078
This issue will finally remove the annoying progress bar? 🙏
<img width="1150" alt="Screenshot 2022-12-06 at 12 16 28 PM" src="https://user-images.githubusercontent.com/9302460/205897311-2a0c8540-12ab-4a43-bff4-e32b71597ff5.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