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

cloudrad: Cross-library links #62

Open
dazuma opened this issue Jan 18, 2022 · 0 comments
Open

cloudrad: Cross-library links #62

dazuma opened this issue Jan 18, 2022 · 0 comments
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@dazuma
Copy link
Member

dazuma commented Jan 18, 2022

Cross-reference links sometimes span libraries. Common cases include:

  • References in wrapper libraries that reference types in gapic libraries.
  • References to protobuf core classes like ::Google::Protobuf::Map (usually common types such as ::Google::Protobuf::Timestamp are already generated in proto_docs). We should include the google-protobuf gem in cloudrad and link to the appropriate definitions there
  • Similar for other common gems such as gapic-common and google-cloud-core.
  • References to Ruby core classes that could link to ruby-doc.org

We should have enough control over the overall generation and maintenance of these docs that we can provide cross-reference links for those cases.

@dazuma dazuma added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

1 participant