docs: start architecture document#1449
Merged
coryan merged 3 commits intogoogleapis:mainfrom Mar 10, 2025
Merged
Conversation
This is where we will document the basic structure of the code, and the internals of the main libraries.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1449 +/- ##
=======================================
Coverage 66.74% 66.74%
=======================================
Files 39 39
Lines 2195 2195
=======================================
Hits 1465 1465
Misses 730 730 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
dbolduc
approved these changes
Mar 10, 2025
ARCHITECTURE.md
Outdated
| @@ -0,0 +1,81 @@ | |||
| # Architectuire Guide | |||
|
|
|||
| This document describes the high-level architecture of the Google Cloud C++ | |||
Collaborator
Author
There was a problem hiding this comment.
Now you know where I cut&pasted this from. Fixed.
ARCHITECTURE.md
Outdated
| The goal of the libraries is to provide idiomatic Rust libraries to access | ||
| services in [Google Cloud](https://cloud.google.com). All services are in scope. | ||
| As of 2025-03 we have over 100 libraries, covering most Google Cloud services. | ||
| The APIs are not stable |
ARCHITECTURE.md
Outdated
| client. | ||
| - `src/lro`: support code for long-running operations. | ||
| - `generator/`: the code generator, also known as `sidekick`. | ||
| - `src/integration-tests`: the integration tests. This run against production |
README.md
Outdated
|
|
||
| ## Getting Started | ||
|
|
||
| The [User Guide] includes basic tutorials to get |
Member
There was a problem hiding this comment.
"... to get familiar with the Google Cloud Rust SDK."
?
dbolduc
approved these changes
Mar 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is where we will document the basic structure of the code, and the
internals of the main libraries.