Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pub/Sub Releases Page for Google Cloud Client Library for Python Needs An Update #5894

Closed
anguillanneuf opened this issue Sep 6, 2018 · 16 comments
Assignees
Labels
api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API.

Comments

@anguillanneuf
Copy link
Contributor

The latest release for Pub/Sub is 0.37.2. But the releases page is somewhat behind at 0.30.0.

Could we update this page? https://google-cloud-python.readthedocs.io/en/stable/pubsub/releases.html

@tseaver tseaver added api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API. labels Sep 6, 2018
@tseaver
Copy link
Contributor

tseaver commented Sep 6, 2018

The stable tree in the docs should be removed altogether: it is completely pointless / bogus now that we have deprecated the umbrella package, and is not being updated.

@tseaver
Copy link
Contributor

tseaver commented Sep 7, 2018

@theacodes I tried to poke into this, but couldn't figure out how the contents of the stable/ tree are being populated: test_utils/scripts/update_docs.sh doesn't touch that tree at all.

$ git checkout  gh-pages
Branch gh-pages set up to track remote branch gh-pages from upstream.
Switched to a new branch 'gh-pages'
$ cd stable
$ git log .
commit ec7539ebf717f06f65860b7652031f5a91469741
Author: Christopher Wilcox <[email protected]>
Date:   Mon Apr 23 16:49:18 2018 -0700

    Redirect all pages of GitHub.io site to RTD (#5225)
    
    * generate redirect md for each file in github pages
    add config file that makes redirects work using jekyll plugin
    
    * delete versions not on RTD
    
    * mirror latest to stable

commit db32b916b3e36242dd1561a81131391dadf65ccd
Author: Danny Hermes <[email protected]>
Date:   Wed Dec 20 09:59:08 2017 -0800

    Removing `stable/` docs from `gh-pages`. (#4637)
    
    Done via:
    
      $ git rm -fr stable/
    
    Fixes #4611.

So, it looks like @crwilcox repopulated the stable/ branch in #5225 after @dhermes removed it in #4637. Becuase stable/ is worthless, I'd rather re-remove it and then fix up any links which still point to it.

@theacodes
Copy link
Contributor

Sounds reasonable to me?

tseaver added a commit that referenced this issue Sep 10, 2018
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
@tseaver
Copy link
Contributor

tseaver commented Sep 10, 2018

@theacodes Should the version trees for gcloud stay under gh-pages, e,g the 0.10.0 version. OTOH, all the _modules bits under gh-pages:0.10.0 are broken.

@theacodes
Copy link
Contributor

theacodes commented Sep 10, 2018 via email

@tseaver
Copy link
Contributor

tseaver commented Sep 10, 2018

I don't even know what the _modules bits are for. (/me looks). Hmm, seems to be pages generated for source code.

@theacodes
Copy link
Contributor

theacodes commented Sep 10, 2018 via email

@tseaver
Copy link
Contributor

tseaver commented Sep 11, 2018

So, on the gh-pages branch, should I:

  • git rm -r stable/ 0.*/
  • Or just leave them as they are.

In addition, should we tweak the RTD config to drop the version-specific and stable builds? BTW, if you'd like to add me as a maintainer / owner there, I can poke at it.

@theacodes
Copy link
Contributor

theacodes commented Sep 11, 2018 via email

@tseaver
Copy link
Contributor

tseaver commented Sep 11, 2018

But would it be, post repo-split? I have a suspicion, for instance, that the ginormous docs/bigquery/generated bit (from autosummary) may be killing the RTD build.

@theacodes
Copy link
Contributor

theacodes commented Sep 11, 2018 via email

@tseaver
Copy link
Contributor

tseaver commented Sep 11, 2018

Maybe, but it's also possible we might switch hosting altogether.

Hmm, too bad we don't know somebody who has a free-to-us place to put static HTML for documentation websites. :)

@theacodes
Copy link
Contributor

theacodes commented Sep 11, 2018 via email

@tseaver
Copy link
Contributor

tseaver commented Sep 13, 2018

So, should I just remove the stale pages from the gh-pages branch? E.g.:

$ git fetch --all
$ git checkout gh-pages
$ git merge upstream/gh-pages
$ git rm -r 0.8.0/
$ git rm -r 0.9.0/
$ git rm -r 0.10.0/
$ git rm -r 0.10.1/
$ git rm -r stable/
$ git commit -m "Take out trash."
$ git push upstream gh-pages

@theacodes
Copy link
Contributor

theacodes commented Sep 13, 2018 via email

@tseaver
Copy link
Contributor

tseaver commented Sep 13, 2018

tseaver added a commit that referenced this issue Sep 13, 2018
Add a 404 page to help direct folks to 'latest'.

Closes #5894
atulep pushed a commit that referenced this issue Apr 3, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
atulep pushed a commit that referenced this issue Apr 18, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Jun 4, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Jun 4, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Sep 22, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Sep 22, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Sep 22, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Oct 21, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Oct 21, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Oct 21, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Oct 22, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Oct 22, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
parthea pushed a commit that referenced this issue Oct 31, 2023
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants