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-only] enhancement(docs): first draft of the activities service adr #9187

Merged
merged 3 commits into from
May 24, 2024

Conversation

fschade
Copy link
Contributor

@fschade fschade commented May 16, 2024

Adds ADR for the new activities service, please add your thoughts below.
Fixes #9075

Copy link

update-docs bot commented May 16, 2024

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@fschade fschade changed the title enhancement(docs): first draft of the activities service adr [docs-only] enhancement(docs): first draft of the activities service adr May 16, 2024

### Activity store

* Use a go-micro store to store the individual activities.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you stick to the ADR template and keep one headline per option?

Mabe make two ADRs one for store and one for format?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

can u explain what you mean, its a bit unclear to us?

Copy link
Member

Choose a reason for hiding this comment

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

Or maybe even three ADRs: one for store, one for format, one for API.

@fschade fschade requested a review from kobergj May 17, 2024 10:40
docs/ocis/adr/0028-activities-service.md Outdated Show resolved Hide resolved
* Activities should be stored in a way that they can be queried efficiently.
* Activities should stay in place event if the resource is gone.
* Activities reflect the state at a given point in time and not the current state.
* The Service should only store a configurable number of activities per resource.
Copy link
Member

Choose a reason for hiding this comment

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

What's the story behind this statement? Usually I want to have all activity since the beginning of the universe.

Copy link
Collaborator

@kobergj kobergj May 23, 2024

Choose a reason for hiding this comment

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

We were worried about amount of data store. But this limit can be deactivated if you have eternal space on your harddrive.

docs/ocis/adr/0028-activities-service.md Show resolved Hide resolved
docs/ocis/adr/0028-activities-service.md Show resolved Hide resolved
docs/ocis/adr/0028-activities-service.md Show resolved Hide resolved
docs/ocis/adr/0028-activities-service.md Outdated Show resolved Hide resolved
## Pros and Cons of the Options <!-- optional -->

* Activity store:
* (PRO) Introducing a new database type might be more efficient for storing activities.
Copy link
Member

Choose a reason for hiding this comment

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

Why is this a PRO?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Its a PRO for using another database

docs/ocis/adr/0028-activities-service.md Outdated Show resolved Hide resolved

### Activity store

* Use a go-micro store to store the individual activities.
Copy link
Member

Choose a reason for hiding this comment

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

Or maybe even three ADRs: one for store, one for format, one for API.

feat(adr): Review suggestions

Co-authored-by: Benedikt Kulmann <benedikt@kulmann.biz>
Copy link

sonarcloud bot commented May 23, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Member

@kulmann kulmann left a comment

Choose a reason for hiding this comment

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

Happy to get it merged in this state. ADR status is draft anyway. Thanks for working on this!

@kobergj kobergj marked this pull request as ready for review May 24, 2024 08:00
@kobergj kobergj merged commit 5f831c0 into owncloud:master May 24, 2024
2 checks passed
ownclouders pushed a commit that referenced this pull request May 24, 2024
[docs-only] enhancement(docs): first draft of the activities service adr
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.

[ocis][adr] Write ADR for activities API and store - 4 PD
4 participants