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

Replace GitOps Toolkit in docs #395

Merged
merged 2 commits into from
Oct 29, 2020
Merged

Replace GitOps Toolkit in docs #395

merged 2 commits into from
Oct 29, 2020

Conversation

squaremo
Copy link
Member

@squaremo squaremo commented Oct 29, 2020

This replaces most mentions of "GitOps Toolkit" and "toolkit" with "Flux". I have adopted the style of using "Flux v2" in the first mention, and thereafter just "Flux" (except where contrasting with Flux v1).

Ref: #388


By basing these controllers on modern Kubernetes tooling (`controller-runtime` libraries), they can be dynamically configured with Kubernetes custom resources either by cluster admins or by other automated tools -- and you get greatly increased observability.

This gave us the opportunity to build the GitOps Toolkit with the top Flux feature requests in mind:
This gave us the opportunity to build FLux v2 with the top Flux v1 feature requests in mind:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This gave us the opportunity to build FLux v2 with the top Flux v1 feature requests in mind:
This gave us the opportunity to build Flux v2 with the top Flux v1 feature requests in mind:

Copy link
Member Author

Choose a reason for hiding this comment

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

I knew this one would trip me up, I type that all the time

Copy link
Member Author

Choose a reason for hiding this comment

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

I found two more places I'd done that!

@hiddeco
Copy link
Member

hiddeco commented Oct 29, 2020

Is it an idea to change the site_name value in mkdocs.yaml to Flux | GitOps Toolkit or Flux v2? (Also, site_author in this doc is still "Flux CD contributors" instead of "Flux authors").

@stefanprodan
Copy link
Member

I would go with Flux | GitOps Toolkit

@squaremo squaremo force-pushed the replace-in-docs branch 2 times, most recently from 628d126 to 4eefa54 Compare October 29, 2020 17:00
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

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

💯

This replaces most mentions of "GitOps Toolkit" and "toolkit" with
"Flux". I have adopted the style of using "Flux v2" in the first
mention, and thereafter just "Flux".

Signed-off-by: Michael Bridgen <michael@weave.works>
I changed the author "The Flux project", since it seemed oddly
redundant to effectively say "the author is the Flux authors".

Signed-off-by: Michael Bridgen <michael@weave.works>
@squaremo squaremo merged commit 815dad1 into main Oct 29, 2020
@squaremo squaremo deleted the replace-in-docs branch October 29, 2020 17:21
@hiddeco hiddeco added the area/docs Documentation related issues and pull requests label Oct 29, 2020
ybelleguic pushed a commit to ybelleguic/flux2 that referenced this pull request Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants