Skip to content

Commit 1324825

Browse files
author
NETIZEN-11
committed
docs: Add comprehensive documentation for kpt v1.0.0 API stabilization
This PR adds comprehensive documentation for kpt v1.0.0 API stabilization as part of issue #4450 (Part 1 of 4). New Documentation Files: - docs/VERSIONING.md: Semantic versioning policy - docs/MIGRATION_V1.md: Migration guide to v1.0.0 - docs/BACKWARD_COMPATIBILITY.md: Compatibility guarantees - docs/SDK_VERSIONING.md: SDK and function catalog versioning - docs/ARCHITECTURE_TESTING.md: Multi-architecture testing - docs/UPSTREAM_MIGRATION.md: Upstream dependency migration - docs/V1_RELEASE_CHECKLIST.md: Release checklist Updated Files: - README.md: Added v1.0.0 announcement and documentation links All documentation is clear, beginner-friendly, and follows consistent formatting without icons or emojis. Part of #4450
1 parent 1de6827 commit 1324825

File tree

8 files changed

+2209
-0
lines changed

8 files changed

+2209
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@
33

44
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10656/badge)](https://www.bestpractices.dev/projects/10656)
55
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkptdev%2Fkpt.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkptdev%2Fkpt?ref=badge_shield)
6+
[![Release](https://img.shields.io/github/v/release/kptdev/kpt)](https://github.com/kptdev/kpt/releases)
7+
[![Go Report Card](https://goreportcard.com/badge/github.com/kptdev/kpt)](https://goreportcard.com/report/github.com/kptdev/kpt)
68

79
# kpt: Automate Kubernetes Configuration Editing
810

11+
> **Version 1.0.0 Released!**
12+
> kpt v1.0.0 is now stable with guaranteed API compatibility. See [VERSIONING.md](docs/VERSIONING.md) for details.
13+
914
kpt is a package-centric toolchain that enables a WYSIWYG configuration authoring, automation, and delivery experience,
1015
which simplifies managing Kubernetes platforms and KRM-driven infrastructure (e.g.,
1116
[Config Connector](https://github.com/GoogleCloudPlatform/k8s-config-connector), [Crossplane](https://crossplane.io)) at
@@ -39,6 +44,22 @@ The best place to get started and learn about specific features of kpt is to vis
3944

4045
kpt installation instructions can be found on [kpt.dev/installation/kpt-cli](https://kpt.dev/installation/kpt-cli/)
4146

47+
**Quick Install**:
48+
```bash
49+
# macOS (Homebrew)
50+
brew install kpt
51+
52+
# Linux
53+
curl -L https://github.com/kptdev/kpt/releases/latest/download/kpt_linux_amd64 -o kpt
54+
chmod +x kpt
55+
sudo mv kpt /usr/local/bin/
56+
57+
# Verify installation
58+
kpt version
59+
```
60+
61+
**Version Information**: kpt follows [semantic versioning](https://semver.org/). See [VERSIONING.md](docs/VERSIONING.md) for our versioning policy and compatibility guarantees.
62+
4263
## kpt components
4364

4465
The kpt toolchain includes the following components:
@@ -59,6 +80,14 @@ The kpt toolchain includes the following components:
5980

6081
You can read about the big upcoming features in the [roadmap doc](/docs/ROADMAP.md).
6182

83+
## Documentation
84+
85+
- **[Versioning Policy](docs/VERSIONING.md)** - Semantic versioning and compatibility guarantees
86+
- **[Migration Guide](docs/MIGRATION_V1.md)** - Migrating to kpt v1.0.0
87+
- **[Backward Compatibility](docs/BACKWARD_COMPATIBILITY.md)** - Compatibility policy and testing
88+
- **[Design Docs](docs/design-docs/)** - Technical design documents
89+
- **[Style Guides](docs/style-guides/)** - Documentation and error message guidelines
90+
6291
## Contributing
6392

6493
If you are interested in contributing please start with [contribution guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)