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

Source Code links broken in Ruby docs #908

Closed
omaray opened this issue Sep 18, 2016 · 4 comments
Closed

Source Code links broken in Ruby docs #908

omaray opened this issue Sep 18, 2016 · 4 comments
Assignees
Labels
type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Milestone

Comments

@omaray
Copy link

omaray commented Sep 18, 2016

It seems like all the Source Code links in the Ruby docs are broken at the moment.

As an example, if you navigate to the root of the docs and look for the first Source Code link, it won't work.

And this seems to be the case for all of them:
image

@omaray omaray added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. docs labels Sep 18, 2016
@quartzmo quartzmo self-assigned this Sep 18, 2016
@quartzmo
Copy link
Member

Thanks @omaray. I think fixing this will require an update to our JSON docs generation. I'll look into it.

@quartzmo
Copy link
Member

GoogleCloudPlatform/gcloud-common#188 added support to the site for git tags containing both package name and version number, solving one cause of this issue.

I've fixed the links in all individual packages manually (and will follow up with automation), but the links for the "umbrella" package will require a change to our JSON docs generation.

Example of a current (broken) path:

https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/google-cloud/v0.20.0/google-cloud/lib/google-cloud-bigquery.rb#L65

And the correct path:

https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/google-cloud/v0.20.0/google-cloud-bigquery/lib/google-cloud-bigquery.rb#L65

At the same time that I make this fix, I will probably produce the automation for the manual updates I made earlier.

@quartzmo quartzmo modified the milestone: Speech Sep 22, 2016
quartzmo added a commit to quartzmo/google-cloud-ruby that referenced this issue Sep 23, 2016
quartzmo added a commit that referenced this issue Sep 23, 2016
@omaray
Copy link
Author

omaray commented Sep 26, 2016

Thanks for looking into this Chris and also automating the process to ensure there are no regressions.

@quartzmo
Copy link
Member

Reopening since although this solution has been merged, the fix has not yet been applied to all of the latest library versions in documentation. (#965)

@quartzmo quartzmo reopened this Oct 13, 2016
@blowmage blowmage modified the milestones: Speech, v0.21, v1 Beta Oct 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

3 participants