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

DSET-3941: Document architecture #33

Merged
merged 7 commits into from
Jun 13, 2023
Merged

Conversation

martin-majlis-s1
Copy link
Collaborator

Initial version of the design document

It's structured in the following way:

  1. What I believe is true about the systems with which it interacts.
  2. What are the consequences of 1
  3. How I implemented 2
  4. Details about some subsystems

docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
@zdaratom-s1
Copy link
Collaborator

zdaratom-s1 commented Jun 9, 2023

@martin-majlis-s1 thank for the document, helped me to understand how the system behaves.

@zdaratom-s1
Copy link
Collaborator

Lets also update link in https://github.com/scalyr/dataset-go#architecture to this document and maybe also consider moving the diagram to this document since its related

docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
docs/ARCHITECTURE.md Outdated Show resolved Hide resolved
@zdaratom-s1 zdaratom-s1 force-pushed the DSET-3941-documentation branch from ddd932e to 516f8a2 Compare June 13, 2023 11:40
Copy link
Collaborator

@zdaratom-s1 zdaratom-s1 left a comment

Choose a reason for hiding this comment

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

addressed notes based on discussion with @martin-majlis-s1

@zdaratom-s1 zdaratom-s1 force-pushed the DSET-3941-documentation branch from 516f8a2 to 3031c44 Compare June 13, 2023 11:59
@codecov-commenter
Copy link

Codecov Report

Merging #33 (6f3b2c8) into main (813a0d1) will increase coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #33      +/-   ##
==========================================
+ Coverage   74.00%   74.07%   +0.07%     
==========================================
  Files          10       10              
  Lines        1377     1377              
==========================================
+ Hits         1019     1020       +1     
  Misses        296      296              
+ Partials       62       61       -1     

see 2 files with indirect coverage changes

@zdaratom-s1 zdaratom-s1 enabled auto-merge June 13, 2023 13:47
@zdaratom-s1 zdaratom-s1 added this pull request to the merge queue Jun 13, 2023
Merged via the queue into main with commit c008244 Jun 13, 2023
@zdaratom-s1 zdaratom-s1 deleted the DSET-3941-documentation branch June 13, 2023 15:44
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.

4 participants