diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 0c7edb7a..2d353462 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -22,3 +22,63 @@ body { .md-header-nav__title { font-size: .85rem; } + +/* Progress bar styling */ + +.progress-label { + position: absolute; + text-align: center; + font-weight: 700; + width: 100%; + margin: 0 ! important; + line-height: 1.2rem; + white-space: nowrap; + overflow: hidden; + } + + .progress-bar { + height: 1.2rem; + float: left; + background: repeating-linear-gradient( + 45deg, + rgba(255, 255, 255, 0.2), + rgba(255, 255, 255, 0.2) 10px, + rgba(255, 255, 255, 0.3) 10px, + rgba(255, 255, 255, 0.3) 20px + ) #2979ff; + border-radius: 2px; + } + + .progress { + display: block; + width: 100%; + margin: 0.5rem 0; + height: 1.2rem; + background-color: #eeeeee; + position: relative; + border-radius: 2px; + } + + .progress-100plus .progress-bar { + background-color: #00c853; + } + + .progress-80plus .progress-bar { + background-color: #64dd17; + } + + .progress-60plus .progress-bar { + background-color: #fbc02d; + } + + .progress-40plus .progress-bar { + background-color: #ff9100; + } + + .progress-20plus .progress-bar { + background-color: #ff5252; + } + + .progress-0plus .progress-bar { + background-color: #ff1744; + } \ No newline at end of file diff --git a/docs/roadmap/index.md b/docs/roadmap/index.md index 14828b6b..a0d695e7 100644 --- a/docs/roadmap/index.md +++ b/docs/roadmap/index.md @@ -1,5 +1,7 @@ # Roadmap +[= 40% "40%"] + !!! hint "Work in Progress" We will be building the roadmap together with the Flux community, our end-users and everyone who is interested in integrating with us. @@ -16,45 +18,45 @@ and [FluxCloud](https://github.com/justinbarrick/fluxcloud) notifications. Goals -- Offer an in-place migration tool for those that are using Flux in read-only mode to synchronize plain manifests -- Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays -- ~~Offer a dedicated component for forwarding events to external messaging platforms~~ +- [ ] Offer an in-place migration tool for those that are using Flux in read-only mode to synchronize plain manifests +- [ ] Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays +- [x] Offer a dedicated component for forwarding events to external messaging platforms Non-Goals -- Migrate users that are using Flux to run custom scripts with `flux.yaml` -- Automate the migration of `flux.yaml` kustomize users +- [ ] Migrate users that are using Flux to run custom scripts with `flux.yaml` +- [ ] Automate the migration of `flux.yaml` kustomize users Tasks -- ~~Design the events API~~ -- ~~Implement events in source and kustomize controllers~~ -- ~~Make the kustomize-controller apply/gc events on-par with Flux v1 apply events~~ -- ~~Design the notifications and events filtering API~~ -- ~~Implement a notification controller for Slack, MS Teams, Discord, Rocket~~ -- Implement Prometheus metrics in source and kustomize controllers -- Review the git source and kustomize APIs -- Implement the migration command in tk -- Create a migration guide for `flux.yaml` kustomize users +- [x] Design the events API +- [x] Implement events in source and kustomize controllers +- [x] Make the kustomize-controller apply/gc events on-par with Flux v1 apply events +- [x] Design the notifications and events filtering API +- [x] Implement a notification controller for Slack, MS Teams, Discord, Rocket +- [ ] Implement Prometheus metrics in source and kustomize controllers +- [ ] Review the git source and kustomize APIs +- [ ] Implement the migration command in tk +- [ ] Create a migration guide for `flux.yaml` kustomize users ### Flux image update feature parity Goals -- Offer components that can replace Flux v1 image update feature +- [ ] Offer components that can replace Flux v1 image update feature Non-Goals -- Maintain backwards compatibility with Flux v1 annotations +- [ ] Maintain backwards compatibility with Flux v1 annotations Tasks -- [Design the image scanning and automation API](https://github.com/fluxcd/toolkit/discussions/107) -- Implement an image scanning controller -- Design the automation component -- Implement the image scan/patch/push workflow -- Integrate the new components in the toolkit assembler -- Create a migration guide from Flux annotations +- [ ] [Design the image scanning and automation API](https://github.com/fluxcd/toolkit/discussions/107) +- [ ] Implement an image scanning controller +- [ ] Design the automation component +- [ ] Implement the image scan/patch/push workflow +- [ ] Integrate the new components in the toolkit assembler +- [ ] Create a migration guide from Flux annotations ## The road to Helm Operator v2 @@ -62,24 +64,24 @@ Tasks Goals -- Offer a migration guide for those that are using Helm Operator with Helm v3 and Helm repositories +- [ ] Offer a migration guide for those that are using Helm Operator with Helm v3 and Helm repositories Non-Goals -- Migrate users that are using Helm v2 +- [ ] Migrate users that are using Helm v2 Stretch-Goals -- [Migrate users that are using Helm charts from Git](https://github.com/fluxcd/toolkit/discussions/75#discussioncomment-38589) +- [ ] [Migrate users that are using Helm charts from Git](https://github.com/fluxcd/toolkit/discussions/75#discussioncomment-38589) Tasks -- ~~Implement a Helm controller for Helm v3 covering all the current release options~~ -- Discuss and design Helm releases based on source API: - + [Providing values from sources](https://github.com/fluxcd/toolkit/discussions/100) - + [Conditional remediation on failed Helm actions](https://github.com/fluxcd/toolkit/discussions/102) - + [Support running Helm test actions on an interval](https://github.com/fluxcd/toolkit/discussions/103) -- Review the Helm release, chart and repository APIs -- ~~Implement events in Helm controller~~ -- Implement Prometheus metrics in Helm controller -- Create a migration guide for Helm Operator users +- [x] Implement a Helm controller for Helm v3 covering all the current release options +- [ ] Discuss and design Helm releases based on source API: + * [ ] [Providing values from sources](https://github.com/fluxcd/toolkit/discussions/100) + * [ ] [Conditional remediation on failed Helm actions](https://github.com/fluxcd/toolkit/discussions/102) + * [ ] [Support running Helm test actions on an interval](https://github.com/fluxcd/toolkit/discussions/103) +- [ ] Review the Helm release, chart and repository APIs +- [x] Implement events in Helm controller +- [ ] Implement Prometheus metrics in Helm controller +- [ ] Create a migration guide for Helm Operator users diff --git a/mkdocs.yml b/mkdocs.yml index 978f7e78..cced0195 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,6 +35,8 @@ markdown_extensions: highlight_code: true - pymdownx.tabbed - pymdownx.tilde + - pymdownx.progressbar + - pymdownx.tasklist nav: - Introduction: index.md