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.

Sign up for GitHub

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

Jump to bottom

Add design and architecture documents #238

Open
anusha94 opened this issue Nov 11, 2021 · 0 comments · May be fixed by #392
Open

Add design and architecture documents #238

anusha94 opened this issue Nov 11, 2021 · 0 comments · May be fixed by #392
Assignees
@pshail
Labels
kind/documentation Categorizes issue or PR as related to documentation
Milestone
Next

Comments

@anusha94
Copy link
Contributor

Design and architecture documents help users and contributors understand the underpinnings of the project. Create a new architecture.md under docs

Refer to sample architecture doc by Antrea
@anusha94 anusha94 added the kind/documentation Categorizes issue or PR as related to documentation label Nov 12, 2021
@jamiemonserrate jamiemonserrate added this to the v0.1.1 milestone Nov 26, 2021
@jamiemonserrate jamiemonserrate added this to To do in v0.1.1 via automation Nov 26, 2021
@pshail pshail self-assigned this Dec 2, 2021
@anusha94 anusha94 mentioned this issue Feb 1, 2022
Merged
pshail added a commit to pshail/cluster-api-provider-bringyourownhost that referenced this issue Feb 21, 2022
@pshail
- Update README with link to architecture and design section
6f4ad9b 
 - Restructure design doc folders
 - Link the existing sequence diagram in readme
 Partially fixes vmware-tanzu#238
Signed-off-by: Shailesh Pant <7968042+pshail@users.noreply.github.com>
pshail added a commit to pshail/cluster-api-provider-bringyourownhost that referenced this issue Feb 21, 2022
@pshail
- Update README with link to architecture and design section
268b43c 
 - Restructure design doc folders
 - Link the existing sequence diagram in readme
 Partially fixes vmware-tanzu#238
Signed-off-by: Shailesh Pant <7968042+pshail@users.noreply.github.com>
pshail added a commit to pshail/cluster-api-provider-bringyourownhost that referenced this issue Feb 21, 2022
@pshail
- Update README with link to architecture and design section
e987584 
 - Restructure design doc folders
 - Link the existing sequence diagram in readme
 Partially fixes vmware-tanzu#238
Signed-off-by: Shailesh Pant <7968042+pshail@users.noreply.github.com>
pshail added a commit to pshail/cluster-api-provider-bringyourownhost that referenced this issue Feb 21, 2022
@pshail
- Update README with link to architecture and design section
6aab8f1 
 - Restructure design doc folders
 - Link the existing sequence diagram in architecture reade
 Partially fixes vmware-tanzu#238
Signed-off-by: Shailesh Pant <7968042+pshail@users.noreply.github.com>
@pshail pshail linked a pull request Feb 21, 2022 that will close this issue
Draft
@anusha94 anusha94 modified the milestones: v0.1.1, Next Mar 4, 2022
@anusha94 anusha94 removed this from To do in v0.1.1 Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pshail pshail

Labels
kind/documentation Categorizes issue or PR as related to documentation
Projects
None yet
Milestone
Next
Development

Successfully merging a pull request may close this issue.

Add architecture and design artefacts pshail/cluster-api-provider-bringyourownhost
3 participants
@jamiemonserrate @pshail @anusha94