-
Notifications
You must be signed in to change notification settings - Fork 327
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
Reorganise and improve the monitoring docs #1628
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stefanprodan
added
area/docs
Documentation related issues and pull requests
area/flux
Flux related issues and pull requests
labels
Aug 16, 2023
I had to make a few changes for the website build to work locally. Just highlighting that the new controller releases have some changes to where the docs exist. I think the changes in #1577 should address this issue. Temporarily, I made the following local changes to be able to build and see the preview: diff --git a/hack/import-flux2-assets.sh b/hack/import-flux2-assets.sh
index e937c9a..21c4c0e 100755
--- a/hack/import-flux2-assets.sh
+++ b/hack/import-flux2-assets.sh
@@ -137,13 +137,13 @@ gen_crd_doc() {
# kustomize-controller CRDs
KUSTOMIZE_VER="$(controller_version kustomize-controller)"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/api/v1/kustomize.md" "$COMPONENTS_DIR/kustomize/api/v1.md" "HUGETABLE"
- gen_crd_doc "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1/kustomization.md" "$COMPONENTS_DIR/kustomize/kustomization.md"
+ gen_crd_doc "https://raw.githubusercontent.com/fluxcd/kustomize-controller/$KUSTOMIZE_VER/docs/spec/v1/kustomizations.md" "$COMPONENTS_DIR/kustomize/kustomization.md"
}
{
# helm-controller CRDs
HELM_VER="$(controller_version helm-controller)"
- gen_crd_doc "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/helmrelease.md" "$COMPONENTS_DIR/helm/api.md" "HUGETABLE"
+ gen_crd_doc "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/api/v2beta1/helm.md" "$COMPONENTS_DIR/helm/api.md" "HUGETABLE"
gen_crd_doc "https://raw.githubusercontent.com/fluxcd/helm-controller/$HELM_VER/docs/spec/v2beta1/helmreleases.md" "$COMPONENTS_DIR/helm/helmreleases.md"
} |
darkowlzz
force-pushed
the
monitoring-v2
branch
from
August 24, 2023 08:16
b6298ab
to
f8783b4
Compare
Signed-off-by: Stefan Prodan <[email protected]>
Signed-off-by: Sunny <[email protected]>
- New path to KSM config. - Updated example config to include the suspend metrics label. Signed-off-by: Sunny <[email protected]>
darkowlzz
force-pushed
the
monitoring-v2
branch
from
August 24, 2023 08:20
f8783b4
to
a6e4382
Compare
Signed-off-by: Sunny <[email protected]>
Signed-off-by: Sunny <[email protected]>
Signed-off-by: Sunny <[email protected]>
Signed-off-by: Sunny <[email protected]>
Signed-off-by: Stefan Prodan <[email protected]>
darkowlzz
force-pushed
the
monitoring-v2
branch
from
August 24, 2023 09:35
d9a142e
to
41e8c88
Compare
hiddeco
approved these changes
Aug 24, 2023
darkowlzz
force-pushed
the
monitoring-v2
branch
from
August 24, 2023 09:53
41e8c88
to
3d7e118
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR reorganises and improves the monitoring documentation.
Preview: https://deploy-preview-1628--fluxcd.netlify.app/flux/monitoring/
Completion status