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/03/22 07:07:48 UTC

[GitHub] [pulsar] michaeljmarshall opened a new pull request #14788: Build python client docs once from published libraries

michaeljmarshall opened a new pull request #14788:
URL: https://github.com/apache/pulsar/pull/14788


   ### Motivation
   
   The website failed to build today due to timeout. I noticed that we're re-building the python libraries from scratch with every website build, for the sole purpose of generating docs that only ever needed to be computed once per release. This is a slow process that wastes resources and likely leads to inaccurate docs. I propose that we pre-generate these docs instead of continuously re-generating them.
   
   Note also that the current docs are incorrectly built from master instead of from the released versions. Here is the current link for 2.9.1's python client: https://pulsar.apache.org/api/python/2.9.0-SNAPSHOT/.
   
   In this PR, I propose that we build the website source code once. It's possible that we might not want to store these generated files here, however, since we already store the swagger files in the same `site2/website/static` directory, this seems to me to be the most natural solution.
   
   ### Modifications
   
   * Remove python client build from website build
   * Update the `replace.js` so that the website renders the links to the `api/python` references correctly.
   * Add generation script for release manager to run
   * Built the python client docs by running the script that I add in this PR
       * `PULSAR_VERSION=2.7.0 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.7.1 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.7.2 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.7.3 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.7.4 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.8.0 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.8.1 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.8.2 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.8.3 ./site2/tools/python-client/build-docs-in-docker.sh`
       * `PULSAR_VERSION=2.9.1 ./site2/tools/python-client/build-docs-in-docker.sh`
   
   ### Verifying this change
   
   Read through the code, ran the generated web pages, and tried to manually verify. I am not certain that this is correct though, so it might need iteration. If someone can verify, that'd be great. Either way, I think we should remove the unnecessary building of the client for every website build.
   
   ### Does this pull request potentially affect one of the following parts:
   
   This only updates the website.
   
   ### Documentation
     
   - [x] `doc` 
     
   This is documentation
   
   
   


-- 
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 commented on pull request #14788: Build python client docs once from published libraries

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14788:
URL: https://github.com/apache/pulsar/pull/14788#issuecomment-1075816459


   @michaeljmarshall thanks for your clear explanations and quick fix!


-- 
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] eolivelli merged pull request #14788: Build python client docs once from published libraries

Posted by GitBox <gi...@apache.org>.
eolivelli merged pull request #14788:
URL: https://github.com/apache/pulsar/pull/14788


   


-- 
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