-
Notifications
You must be signed in to change notification settings - Fork 332
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
[GSoD] Reorganise the installation docs #1560
Comments
stefanprodan
added
area/docs
Documentation related issues and pull requests
area/ux
In pursuit of a delightful user experience
area/flux
Flux related issues and pull requests
labels
Jul 11, 2023
kingdonb
pushed a commit
that referenced
this issue
Jul 11, 2023
If anyone thinks one of these does not need updates, then we can remove it from this list. I added a notice to each doc that I haven't recently reviewed, (regardless of whether I am the original author.) The use-cases docs that are not covered here are all ones intended to be migrated into the Installation guides, per the GSoD plan that is being advanced here. So the use-cases section of the docs may go away entirely, (unless some of these docs turn out to survive all this without getting relocated): #1560 Signed-off-by: Kingdon Barrett <[email protected]>
mehak151
added a commit
to mehak151/website-1
that referenced
this issue
Jul 16, 2023
Remove the following sections to be included in the Bootstrap section later as per fluxcd#1560 Generic Git Server GitHub GitLab BitBucket AWS CodeCommit Azure DevOps Google Cloud Source Signed-off-by: mehak151 <[email protected]>
kingdonb
pushed a commit
that referenced
this issue
Jul 17, 2023
The use-cases docs that are not covered here are all ones intended to be migrated into the Installation guides, per the GSoD plan that is being advanced here. So the use-cases section of the docs may go away entirely, (unless some of these docs turn out to survive all this without getting relocated): #1560 * strengthen some language And break out one of the longer texts into an "info" class message, "Author's Note" Open to suggestions about how to change this to look more Production * ambient credentials used to secure better language karmada condense two disclaimers into one I don't think we will archive the Karmada doc, since it was contributed by an outside person and it is a CNCF Sandbox project, but I'm giving it the same disclaimer as I'm giving all the docs as they're under review. * Remove note from helm promotion guide that was reviewed (fixup) Signed-off-by: Kingdon Barrett <[email protected]> * add warning to e2e guide Signed-off-by: Kingdon Barrett <[email protected]>
This was referenced Jul 21, 2023
stefanprodan
pushed a commit
that referenced
this issue
Aug 1, 2023
Remove the following sections to be included in the Bootstrap section later as per #1560 Generic Git Server GitHub GitLab BitBucket AWS CodeCommit Azure DevOps Google Cloud Source Signed-off-by: mehak151 <[email protected]>
stefanprodan
pushed a commit
that referenced
this issue
Aug 17, 2023
Remove the following sections to be included in the Bootstrap section later as per #1560 Generic Git Server GitHub GitLab BitBucket AWS CodeCommit Azure DevOps Google Cloud Source Signed-off-by: mehak151 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is a proposal to reorganise the installation documentation with the goal of having all the Flux install options and the various bootstrap configurations (Git providers, Cloud providers, controller customisations, multi-tenancy etc) in one place.
The proposal is to split the current page into sections (per Git provider) and to bring together the installation specific information from Cheatsheets (bootstrap and sharding) and Use Cases (azure, aws, gcp) under the installation section.
We'll need to setup redirects for Cheatsheets and Use Cases to limit the impact of these changes. Given that links to these docs are used in hundreds of GH issues, discussions, PRs, Blog posts, Slack threads, StackOverflow, etc we need to make sure people don't end up on a 404 page.
The text was updated successfully, but these errors were encountered: