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

Docs: Update backend architecture contributor documentation #51172

Merged
merged 8 commits into from
Jun 30, 2022

Conversation

sakjur
Copy link
Contributor

@sakjur sakjur commented Jun 21, 2022

What this PR does / why we need it:

We haven't done this in a while 🙈

@grafanabot grafanabot added type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project area/backend enterprise-ok labels Jun 21, 2022
@sakjur sakjur marked this pull request as ready for review June 27, 2022 09:44
@sakjur sakjur requested a review from a team as a code owner June 27, 2022 09:44
@sakjur sakjur requested review from papagian, kylebrandt and ying-jeanne and removed request for a team June 27, 2022 09:44
@sakjur sakjur added this to the 9.1.0 milestone Jun 27, 2022
@sakjur sakjur added no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Jun 27, 2022
@grafanabot
Copy link
Contributor

contribute/architecture/backend/communication.md Outdated Show resolved Hide resolved
contribute/architecture/backend/package-hierarchy.md Outdated Show resolved Hide resolved
contribute/architecture/backend/package-hierarchy.md Outdated Show resolved Hide resolved
contribute/architecture/backend/package-hierarchy.md Outdated Show resolved Hide resolved
// the service except for in Wire.
type Svc struct { … }

func ProviceSvc(numbers numerical.Numerical, db db.DB) Svc { … }
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it worths briefly explaining wire use and linking to this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll leave that out for this PR, but good point for future improvement, thanks!

Comment on lines +159 to +160
Get(ctx.Context, id int) (root.Letter, error)
Delete(ctx.Context, root.DeleteLetterCommand) error
Copy link
Contributor

Choose a reason for hiding this comment

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

Not important but for completeness we need also a function for listing that returns (root.Letters, error)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Heh, getting away with not having that is why there's a "Cached" in the name of the List function 🙃

Copy link
Contributor

Choose a reason for hiding this comment

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

I was wondering about that "Cached"... 😄

sakjur and others added 2 commits June 30, 2022 14:33
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
@grafanabot
Copy link
Contributor

Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
@sakjur sakjur enabled auto-merge (squash) June 30, 2022 14:35
@sakjur sakjur merged commit 0e7a495 into main Jun 30, 2022
@sakjur sakjur deleted the emil/202206/docs branch June 30, 2022 14:47
@grafanabot
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/backend enterprise-failed no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants