Skip to content

Commit

Permalink
docs: Update docs for v0.31.0 (aws#4717)
Browse files Browse the repository at this point in the history
  • Loading branch information
engedaam authored and johngmyers committed May 31, 2024
1 parent a400cd9 commit 7c5e4ab
Show file tree
Hide file tree
Showing 7 changed files with 265 additions and 860 deletions.
4 changes: 2 additions & 2 deletions hack/docgen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ set -euo pipefail

compatibilitymatrix() {
go run hack/docs/version_compatibility.go hack/docs/compatibility-karpenter.yaml "$(git describe --exact-match --tags || echo "no tag")"
go run hack/docs/compatibilitymetrix_gen_docs.go website/content/en/preview/upgrade-guide.md hack/docs/compatibility-karpenter.yaml
go run hack/docs/compatibilitymetrix_gen_docs.go website/content/en/preview/upgrade-guide.md hack/docs/compatibility-karpenter.yaml 6
}


compatibilitymatrix
go run hack/docs/metrics_gen_docs.go pkg/ $(KARPENTER_CORE_DIR)/pkg website/content/en/preview/concepts/metrics.md
go run hack/docs/metrics_gen_docs.go pkg/ ${KARPENTER_CORE_DIR}/pkg website/content/en/preview/concepts/metrics.md
go run hack/docs/instancetypes_gen_docs.go website/content/en/preview/concepts/instance-types.md
go run hack/docs/configuration_gen_docs.go website/content/en/preview/concepts/settings.md
cd charts/karpenter && helm-docs
5 changes: 4 additions & 1 deletion hack/docs/compatibility-karpenter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,7 @@ compatibility:
maxK8sVersion: 1.27
- appVersion: 0.30.x
minK8sVersion: 1.23
maxK8sVersion: 1.27
maxK8sVersion: 1.27
- appVersion: 0.31.x
minK8sVersion: 1.23
maxK8sVersion: 1.28
4 changes: 3 additions & 1 deletion hack/docs/compatibilitymetrix_gen_docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"fmt"
"log"
"os"
"strconv"
"strings"

"github.com/aws/karpenter/tools/kompat/pkg/kompat"
Expand Down Expand Up @@ -54,5 +55,6 @@ func main() {
if err != nil {
log.Fatalf("unable to open %s to write generated output: %v", outputFileName, err)
}
f.WriteString(topDoc + baseText.Markdown(kompat.Options{LastN: 5}) + bottomDoc)
numOfk8sVersion, _ := strconv.Atoi(os.Args[3])
f.WriteString(topDoc + baseText.Markdown(kompat.Options{LastN: numOfk8sVersion}) + bottomDoc)
}
Loading

0 comments on commit 7c5e4ab

Please sign in to comment.