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.

Sign up for GitHub

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

Jump to bottom

[Documentation Issue] #2933

Closed
Avemark opened this issue Feb 19, 2019 · 7 comments · Fixed by #3170
Closed

[Documentation Issue] #2933

Avemark opened this issue Feb 19, 2019 · 7 comments · Fixed by #3170
Assignees
@quartzmo
Labels
api: dialogflow Issues related to the Dialogflow API. type: docs Improvement to the documentation for an API.

Comments

@Avemark
Copy link

Avemark commented Feb 19, 2019

"Setup Authentication" link does not actually link to Authentication information. Further links on the following page leads to an "authentication guide" that does not as much explain authentication as inform you that you should be running the code on a machine where authentication is already available.

A mention on where to get credentials, and an example or description of a credential json would be very helpful here. Also, I'd suggest a direct link to the authentication guide from the first page.
@quartzmo quartzmo self-assigned this Feb 20, 2019
@quartzmo quartzmo added type: docs Improvement to the documentation for an API. api: dialogflow Issues related to the Dialogflow API. labels Feb 20, 2019
@quartzmo
Copy link
Member

@Avemark Thank you for reporting the broken link at "Setup Authentication". And I agree that the top-level authentication guide for google-cloud-ruby that you link seems incomplete.

What do you think of the authentication guide for google-cloud-datastore? Is it adequate?

@quartzmo
Copy link
Member

A mention on where to get credentials, and an example or description of a credential json would be very helpful here.

@Avemark If we fix the "Setup Authentication" to link to an authentication guide that is similar to the authentication guide for google-cloud-datastore (but adapted to google-cloud-dialogflow), will that work for you?

@quartzmo
Copy link
Member

quartzmo commented Mar 5, 2019

Should the scope of this issue be expanded to all generated packages that currently lack an authentication guide?

@Avemark
Copy link
Author

Avemark commented Mar 18, 2019

@quartzmo The linked authentication guide seems a lot more thorough, and a direct link to something similar would have cut down on the time needed for my discovery process a lot.

@quartzmo
Copy link
Member

@blowmage @dazuma @TheRoyalTnetennba Is there any reason why the generated packages do not have an AUTHENTICATION.md file? (See datastore/AUTHENTICATION.md for example.)

If not, do we want one? If so, should I add them manually, or can I update the generation somehow?

@blowmage
Copy link
Contributor

It is not part of the generation process. We would have to add them manually, or configure each gem's synth.py script to generate one.

@quartzmo
Copy link
Member

I'll start work on a PR to add this to synth.py.

@quartzmo quartzmo mentioned this issue Apr 17, 2019
Merged
quartzmo added a commit to quartzmo/google-cloud-ruby that referenced this issue Apr 23, 2019
@quartzmo
Update synth.py files
9b92440 
Add copying of gcp.CommonTemplates().ruby_library()

[fixes googleapis#2933]
@quartzmo quartzmo mentioned this issue Apr 23, 2019
Merged
quartzmo added a commit that referenced this issue Apr 23, 2019
@quartzmo
Update synth.py and add .repo-metadata.json (#3170)
1525122 
* Add synthtool task to top-level Rakefile
* Add .repo-metadata.json to gapic gems
* Update synth.py files to copy synthtool templates

[fixes #2933]
@quartzmo quartzmo mentioned this issue Apr 24, 2019
Merged
quartzmo added a commit to quartzmo/google-cloud-ruby that referenced this issue Apr 24, 2019
@quartzmo
Update AUTHENTICATION.md in veneer gems
8f22e8a 
Update AUTHENTICATION.md to match synthtool template.

[refs googleapis#2933]
@quartzmo quartzmo mentioned this issue Apr 24, 2019
Merged
quartzmo added a commit to quartzmo/google-cloud-ruby that referenced this issue Apr 24, 2019
@quartzmo
Update synth.py in generated packages
331e4b4 
Add AUTHENTICATION.md to file lists in *.gemspec and .yardopts

[refs googleapis#2933]
quartzmo added a commit that referenced this issue Apr 24, 2019
@quartzmo
Manually update AUTHENTICATION.md in veneer gems (#3203)
be423c5 
* Update AUTHENTICATION.md to match synthtool template.
* Revert synth.py and remove .repo-metadata.json in veneer gems

[refs #2933]
quartzmo added a commit that referenced this issue Apr 25, 2019
@quartzmo
Update synth.py to add AUTHENTICATION.md to file lists (#3202)
907cb9e 
* Update synth.py in generated packages
  * Add AUTHENTICATION.md to file lists in .gemspec and .yardopts
* Fix env_var_prefix in google-cloud-text_to_speech/.repo-metadata.json

[refs #2933]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@quartzmo quartzmo

Labels
api: dialogflow Issues related to the Dialogflow API. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update synth.py to copy common synthtool templates (AUTHENTICATION.md) quartzmo/google-cloud-ruby
3 participants
@blowmage @quartzmo @Avemark