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

refactor: architecture documentation #1732

Merged
merged 9 commits into from
Aug 1, 2024
Merged

Conversation

raulb
Copy link
Member

@raulb raulb commented Jul 31, 2024

Description

  • Leaves https://conduit.io/docs/getting-started/architecture as the main source of truth when it comes architecture information, referencing that one from the README.
  • Creates a separate page for the pkg structure to not lose that information that's relevant to this repository.

Quick checks:

  • I have followed the Code Guidelines.
  • There is no other pull request for the same update/change.
  • I have written unit tests.
  • I have made sure that the PR is of reasonable size and can be easily reviewed.

@raulb raulb requested a review from a team as a code owner July 31, 2024 15:44
@raulb raulb self-assigned this Jul 31, 2024
docs/package_structure.md Outdated Show resolved Hide resolved
@hariso
Copy link
Contributor

hariso commented Aug 1, 2024

Thanks for this @raulb ! WDYT about leaving a link to the architecture page somewhere in this repo (e.g. README)?

@raulb
Copy link
Member Author

raulb commented Aug 1, 2024

Thanks for this @raulb ! WDYT about leaving a link to the architecture page somewhere in this repo (e.g. README)?

@hariso It's there! https://github.com/ConduitIO/conduit/pull/1732/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R293

README.md Show resolved Hide resolved
@raulb raulb requested a review from hariso August 1, 2024 14:31
@hariso
Copy link
Contributor

hariso commented Aug 1, 2024

Thanks for this @raulb ! WDYT about leaving a link to the architecture page somewhere in this repo (e.g. README)?

@hariso It's there! https://github.com/ConduitIO/conduit/pull/1732/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R293

Sorry, missed it!

@raulb raulb enabled auto-merge (squash) August 1, 2024 14:57
@raulb raulb merged commit 2da3a0b into main Aug 1, 2024
4 checks passed
@raulb raulb deleted the raul/update-architecture-doc branch August 1, 2024 15:09
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.

3 participants