Skip to content

docs: add initial architecture and container contract docs#655

Merged
jskeet merged 2 commits intogoogleapis:mainfrom
jskeet:architecture
Jul 7, 2025
Merged

docs: add initial architecture and container contract docs#655
jskeet merged 2 commits intogoogleapis:mainfrom
jskeet:architecture

Conversation

@jskeet
Copy link
Copy Markdown
Contributor

@jskeet jskeet commented Jun 26, 2025

For #265
Fixes #330

@jskeet jskeet requested review from codyoss and julieqiu June 26, 2025 16:33
@jskeet
Copy link
Copy Markdown
Contributor Author

jskeet commented Jun 26, 2025

This isn't marked as fixing 265, as I expect we'll want to add more - but I wanted to get feedback on what I've already written. (That feedback may well include "topic X doesn't belong in an architecture doc" or "topic Y needs to be covered in the architecture doc" of course.)

@julieqiu
Copy link
Copy Markdown
Member

@zhumin8 @JoeWang1127 @chingor13 @cuiy0006 @dangazineu @meltsufin - would you mind reviewing this also, and leaving comments / questions about anything that needs clarification?

@jskeet - I'll plan on reviewing this tomorrow / Monday

@julieqiu
Copy link
Copy Markdown
Member

@jskeet - would you mind copying this to a Google doc and sharing with the team for feedback? I started to review, and think it will be easier to leave comments in a doc, then paste it back in

Copy link
Copy Markdown
Member

@julieqiu julieqiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jskeet
Copy link
Copy Markdown
Contributor Author

jskeet commented Jun 27, 2025

Done: go/sdk-librarian-pr655

@jskeet
Copy link
Copy Markdown
Contributor Author

jskeet commented Jun 29, 2025

Thanks @jba - I'll copy all of these into our internal doc in the morning (where I suspect there will be more comments).

Copy link
Copy Markdown
Contributor Author

@jskeet jskeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes made in the internal doc. I've left a couple of comments open deliberately for further input.

codyoss
codyoss previously approved these changes Jul 7, 2025
Copy link
Copy Markdown
Member

@codyoss codyoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am good landing what we have here as is. Once this is merged I will update some of our issues to say update these as a part of their task.

@jskeet
Copy link
Copy Markdown
Contributor Author

jskeet commented Jul 7, 2025

@codyoss I'll apply the changes I've already got internally, because they fix some typos etc and link to the v0.1.0 code - after which we should merge.

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@104cc19). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #655   +/-   ##
=======================================
  Coverage        ?   19.88%           
=======================================
  Files           ?       27           
  Lines           ?     2892           
  Branches        ?        0           
=======================================
  Hits            ?      575           
  Misses          ?     2293           
  Partials        ?       24           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jskeet
Copy link
Copy Markdown
Contributor Author

jskeet commented Jul 7, 2025

@codyoss Internal changes are now in a second commit. If you're happy with those, I'll resolve the remaining comments and dismiss the request for changes, then squash and merge.

@jskeet jskeet dismissed julieqiu’s stale review July 7, 2025 13:29

Dismissing review as we've done what was requested, and Julie is away.

@jskeet jskeet merged commit e04c31c into googleapis:main Jul 7, 2025
6 checks passed
@jskeet jskeet deleted the architecture branch July 7, 2025 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: add container command documentation under doc/

4 participants