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: Update notes on Argo+Flux collaboration #126

Merged
merged 3 commits into from
Aug 25, 2020
Merged

docs: Update notes on Argo+Flux collaboration #126

merged 3 commits into from
Aug 25, 2020

Conversation

dholbach
Copy link
Contributor

It's been a while since we wrote most of the docs for the GitOps Engine. In the meantime the Flux project has announced the plans to build Flux v2 on top of the GitOps Toolkit. This PR aims to update the docs to reflect this.

For everyone hasn't followed the news closely: This was discussed between project leads of both projects and we consider the time of collaboration as very fruitful: both Argo and Flux developed a new vision on this quest.

Right now this is a draft PR still, some other bits might need updating but I'd defer the decision to maintainers of the GitOps Engine.

What I did in the PR already:

  • update main README
  • add some more backstory in the FAQ

What I can see as TODO (potentially part of subsequent PRs though):

  • update diagram in main README (not sure where the source of this is)
  • update other FAQ items to explain the direction and positioning of the GitOps Engine
  • quite a few other Flux mentions (might still be useful to keep in spec documents?)
[daniel@reef gitops-engine ]$ git grep -i flux | cut -d':' -f1 | uniq -c
     11 docs/faq.md
      4 specs/deployment-repo-update.md
      7 specs/design-bottom-up.md
     22 specs/design-top-down.md
      6 specs/design.md
      3 specs/image-update-monitoring.md
[daniel@reef gitops-engine ]$ 

CCing @alexmt @jessesuen @jaypipes @2opremio @hiddeco @squaremo @stefanprodan

@dholbach dholbach changed the title Update notes on Argo+Flux collaboration docs: Update notes on Argo+Flux collaboration Aug 24, 2020
@codecov-commenter
Copy link

codecov-commenter commented Aug 24, 2020

Codecov Report

Merging #126 into master will increase coverage by 0.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #126      +/-   ##
==========================================
+ Coverage   55.95%   56.01%   +0.06%     
==========================================
  Files          25       25              
  Lines        2688     2701      +13     
==========================================
+ Hits         1504     1513       +9     
- Misses       1043     1045       +2     
- Partials      141      143       +2     
Impacted Files Coverage Δ
pkg/diff/diff.go 65.55% <0.00%> (+0.15%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bf8e17f...0dc28f3. Read the comment docs.

@dholbach
Copy link
Contributor Author

I could file separate issues for the remaining bits too if you like.

@sonarcloud
Copy link

sonarcloud bot commented Aug 25, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
2.6% 2.6% Duplication

Copy link
Contributor

@alexmt alexmt left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you @dholbach !

@dholbach dholbach marked this pull request as ready for review August 25, 2020 16:04
@alexmt alexmt merged commit 26efb17 into argoproj:master Aug 25, 2020
@dholbach dholbach deleted the gitops-toolkit-and-gitops-engine branch August 25, 2020 16:10
@dholbach dholbach mentioned this pull request Feb 15, 2021
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