Skip to content

Commit 0ec68cf

Browse files
authored
Merge pull request #955 from negz/v2-for-reals
Prepare docs for v2.0 release
2 parents 431e87a + 8a65d21 commit 0ec68cf

File tree

119 files changed

+4228
-17362
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+4228
-17362
lines changed

.github/workflows/link-checker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
- name: Setup Hugo
2020
uses: peaceiris/actions-hugo@v2
2121
with:
22-
hugo-version: '0.119.0'
22+
hugo-version: '0.147.3'
2323
extended: true
2424

2525
- name: Build

.github/workflows/weekly-link-checker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
- name: Setup Hugo
1919
uses: peaceiris/actions-hugo@v2
2020
with:
21-
hugo-version: '0.119.0'
21+
hugo-version: '0.147.3'
2222
extended: true
2323

2424
- name: Build

content/master/_index.md

Lines changed: 22 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,39 @@
11
---
2-
title: "Overview"
2+
title: "Welcome"
33
weight: -1
44
cascade:
55
version: "master"
66
---
77

8-
{{< img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}}
8+
Welcome to the Crossplane documentation. Crossplane is a control plane framework
9+
for platform engineering.
910

10-
<br />
11+
# Using the documentation
1112

12-
Crossplane is an open source Kubernetes extension that transforms your Kubernetes
13-
cluster into a **universal control plane**.
13+
Crossplane organizes its documentation into the following sections:
1414

15-
Crossplane lets you manage anything, anywhere, all through standard Kubernetes
16-
APIs. Crossplane can even let you
17-
[order a pizza](https://blog.crossplane.io/providers-101-ordering-pizza-with-kubernetes-and-crossplane/)
18-
directly from Kubernetes. If it has an API, Crossplane can connect to it.
15+
* [What's Crossplane?]({{<ref "./whats-crossplane">}}) introduces Crossplane
16+
and explains why you should use it.
1917

20-
With Crossplane, platform teams can create new abstractions and custom
21-
APIs with the full power of Kubernetes policies, namespaces, role based access
22-
controls and more. Crossplane brings all your non-Kubernetes resources under
23-
one roof.
18+
* [What's New in v2?]({{<ref "whats-new">}}) highlights what's changed in
19+
Crossplane v2.
2420

25-
Custom APIs, created by platform teams, allow security and compliance
26-
enforcement across resources or clouds, without exposing any complexity to the
27-
developers. A single API call can create multiple resources, in multiple clouds
28-
and use Kubernetes as the control plane for everything.
21+
* [Get Started]({{<ref "get-started">}}) explains how to install Crossplane and
22+
create a control plane.
2923

30-
{{< hint "tip" >}}
31-
**What's a control plane?**
32-
<!-- vale Google.WordList = NO -->
33-
Control planes create and manage the lifecycle of resources. Control planes
34-
constantly _check_ that the intended resources exist, _report_ when the intended
35-
state doesn't match reality and _act_ to make things right.
24+
* [Composition]({{<ref "composition">}}) covers the key concepts of composition.
3625

37-
Crossplane extends the Kubernetes control plane to be a **universal control
38-
plane** to check, report and act on any resource, anywhere.
39-
<!-- vale Google.WordList = YES -->
40-
{{< /hint >}}
26+
* [Managed Resources]({{<ref "managed-resources">}}) covers the key concepts of
27+
managed resources.
4128

29+
* [Packages]({{<ref "packages">}}) covers the key concepts of the Crossplane
30+
package manager.
4231

43-
# Get started
44-
* [Install Crossplane]({{<ref "software/install">}}) in your Kubernetes cluster
45-
* Learn more about how Crossplane works in the
46-
[Crossplane introduction]({{<ref "getting-started/introduction" >}})
47-
* Join the [Crossplane Slack](https://slack.crossplane.io/) and start a
48-
conversation with a community of over 7,000 operators.
32+
* [Guides]({{<ref "guides">}}) guide you through common use cases, like
33+
monitoring Crossplane or extending it by writing a composition function.
4934

35+
* [CLI Reference]({{<ref "cli">}}) documents the `crossplane` command-line
36+
interface that you can use to configure a Crossplane control plane.
5037

51-
Crossplane is a [Cloud Native Compute Foundation](https://www.cncf.io/) project.
38+
* [API Reference]({{<ref "api">}}) documents the APIs that you can use to
39+
configure a Crossplane control plane.

content/master/api/_index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,3 @@ cascade:
88

99
The Crossplane API describes the types and parameters for the core Crossplane
1010
components.
11-
12-
For details on the components read the [Concepts]({{<ref "../concepts/">}})
13-
section.

0 commit comments

Comments
 (0)