Skip to content

: docs: Add comprehensive documentation for kpt v1.0.0 API stabilization #4499

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.

Sign up for GitHub

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

Open
NETIZEN-11 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

: docs: Add comprehensive documentation for kpt v1.0.0 API stabilization #4499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10656/badge)](https://www.bestpractices.dev/projects/10656)
[![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)
[![Release](https://img.shields.io/github/v/release/kptdev/kpt)](https://github.com/kptdev/kpt/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/kptdev/kpt)](https://goreportcard.com/report/github.com/kptdev/kpt)

# kpt: Automate Kubernetes Configuration Editing

> **Version 1.0.0 Released!**
> kpt v1.0.0 is now stable with guaranteed API compatibility. See [VERSIONING.md](docs/VERSIONING.md) for details.

kpt is a package-centric toolchain that enables a WYSIWYG configuration authoring, automation, and delivery experience,
which simplifies managing Kubernetes platforms and KRM-driven infrastructure (e.g.,
[Config Connector](https://github.com/GoogleCloudPlatform/k8s-config-connector), [Crossplane](https://crossplane.io)) at
Expand Down Expand Up @@ -39,6 +44,22 @@ The best place to get started and learn about specific features of kpt is to vis

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

**Quick Install**:
```bash
# macOS (Homebrew)
brew install kpt

# Linux
curl -L https://github.com/kptdev/kpt/releases/latest/download/kpt_linux_amd64 -o kpt
chmod +x kpt
sudo mv kpt /usr/local/bin/

# Verify installation
kpt version
```

**Version Information**: kpt follows [semantic versioning](https://semver.org/). See [VERSIONING.md](docs/VERSIONING.md) for our versioning policy and compatibility guarantees.

## kpt components

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

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

## Documentation

- **[Versioning Policy](docs/VERSIONING.md)** - Semantic versioning and compatibility guarantees
- **[Migration Guide](docs/MIGRATION_V1.md)** - Migrating to kpt v1.0.0
- **[Backward Compatibility](docs/BACKWARD_COMPATIBILITY.md)** - Compatibility policy and testing
- **[Design Docs](docs/design-docs/)** - Technical design documents
- **[Style Guides](docs/style-guides/)** - Documentation and error message guidelines

## Contributing

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