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

Updating docs link in README. #2147

Merged
merged 1 commit into from
Aug 23, 2016
Merged

Updating docs link in README. #2147

merged 1 commit into from
Aug 23, 2016

Conversation

dhermes
Copy link
Contributor

@dhermes dhermes commented Aug 19, 2016

@tswast Sorry I wanted to get rid of the branch in https://github.com/GoogleCloudPlatform/gcloud-python and the PR went stale.


@daspecster We previously followed the readthedocs.org of docs at

{URI}/stable -- last release
{URI}/latest -- HEAD of source
{URI}/0.1.0
{URI}/0.2.0
{URI}/0.2.1
...

Can we restore this (outside of this PR)?

@dhermes dhermes added the docs label Aug 19, 2016
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 19, 2016
@dhermes
Copy link
Contributor Author

dhermes commented Aug 23, 2016

@daspecster Please weigh in here

@daspecster
Copy link
Contributor

We can get 0.17.0 and onward I believe, but latest and stable would have to be branches. I don't think the other languages have stable and latest but I could be wrong(I checked node and ruby). They have master and then versions.

@dhermes
Copy link
Contributor Author

dhermes commented Aug 23, 2016

I don't think the other languages have stable and latest but I could be wrong (I checked node and ruby)

We are following a Python language / readthedocs.org convention.


Also our old docs should be linked to (we can try to map the new docs CSS onto them, but IMO we shouldn't put the time in, we should just use the old docs)

@daspecster
Copy link
Contributor

Also our old docs should be linked to (we can try to map the new docs CSS onto them, but IMO we shouldn't put the time in, we should just use the old docs)

Can you expound on this a little more?

@dhermes
Copy link
Contributor Author

dhermes commented Aug 23, 2016

Can you expound on this a little more?

As for "linked to", see what I mean in the old docs

http://googlecloudplatform.github.io/gcloud-python/latest/
http://googlecloudplatform.github.io/gcloud-python/stable/
http://googlecloudplatform.github.io/gcloud-python/versions.html
http://googlecloudplatform.github.io/gcloud-python/0.17.0/
http://googlecloudplatform.github.io/gcloud-python/0.16.1/
etc.


As for the CSS, I was just saying we check out the tags and run the gcloud-common generator at that point. But it's not worth it (and lots of docsets leave the old versions as-is as a rule)

@daspecster
Copy link
Contributor

Ok, yeah that's why I left those in gh-pages. Where should we add the links to them? Maybe in home.html somewhere?

@dhermes
Copy link
Contributor Author

dhermes commented Aug 23, 2016

The dropdown should just include all the versions.

Is this PR good to merge?

@daspecster
Copy link
Contributor

LGTM

@dhermes dhermes merged commit 250d8c9 into googleapis:master Aug 23, 2016
@dhermes dhermes deleted the fix-2069 branch August 23, 2016 18:17
@dhermes dhermes mentioned this pull request Sep 19, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants