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

a set of internal docs that to complete the picture about weave gitops engineering #3404

Merged
merged 17 commits into from
Sep 29, 2023

Conversation

enekofb
Copy link
Contributor

@enekofb enekofb commented Sep 26, 2023

What changed?

Added some documentation to give an overview on some engineering topics like cicd, code quality and security, dataflows, etc ...

Why was this change made?

It was requested to document some of these aspects for external consumption. I guess that adding it here would help with similar future needs and iterations.

How was this change implemented?

Documentation added based to the best of my knowledge and restricted to the time we got (~ a day or so).

Other follow ups

TBD

@enekofb enekofb added the exclude from release notes Use this label to exclude a PR from the release notes label Sep 27, 2023
@enekofb enekofb requested a review from squaremo September 27, 2023 14:19
@enekofb enekofb marked this pull request as ready for review September 27, 2023 14:19
Copy link
Contributor

@squaremo squaremo left a comment

Choose a reason for hiding this comment

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

Nice one bringing this all together @enekofb. I have just cosmetic things to suggest -- in fact mainly just capitalisation :-D I would suggest being more precise about the benefits of using golang -- I've made specific suggestions for that in the comments, in two places.

docs/architecture/README.md Outdated Show resolved Hide resolved
docs/architecture/README.md Outdated Show resolved Hide resolved
docs/architecture/README.md Outdated Show resolved Hide resolved
docs/architecture/README.md Outdated Show resolved Hide resolved
docs/architecture/README.md Outdated Show resolved Hide resolved
docs/architecture/README.md Outdated Show resolved Hide resolved
docs/cicd.md Outdated Show resolved Hide resolved
docs/cicd.md Outdated Show resolved Hide resolved
docs/cicd.md Outdated Show resolved Hide resolved
docs/code-quality.md Outdated Show resolved Hide resolved
@enekofb enekofb merged commit 6c5556c into main Sep 29, 2023
@enekofb enekofb deleted the internal-docs branch September 29, 2023 06:20
@enekofb
Copy link
Contributor Author

enekofb commented Sep 29, 2023

Thanks, Michael for your review and on-point comments. Have updated also the google doc reflecting the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exclude from release notes Use this label to exclude a PR from the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants