Skip to content

Commit 2b598cb

Browse files
authored
Remove knowledge base section (#755)
Remove KB and add redirects
1 parent e2603a9 commit 2b598cb

File tree

115 files changed

+16243
-403
lines changed

Some content is hidden

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

115 files changed

+16243
-403
lines changed

content/contribute/contribute.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -54,43 +54,6 @@ To create new content create a new markdown file in the appropriate location.
5454
To create a new section, create a new directory and an `_index.md` file in the
5555
root.
5656

57-
### Types of content
58-
Crossplane documentation has three content sections:
59-
* The [Contributing Guide]({{<ref "/contribute/_index.md">}}) with details on
60-
how to contribute to the Crossplane documentation.
61-
* The [Knowledge Base]({{<ref "/knowledge-base" >}}) is for content related to
62-
Crossplane integrations, in-depth articles or how-to guides.
63-
* [User documentation]({{<ref "/master" >}}) are for generic documentation,
64-
commonly version-specific.
65-
66-
#### User documentation vs knowledge base articles
67-
User documentation includes both _conceptual_ and _procedural_ instructions.
68-
69-
_Conceptual_ content describes the background and theory behind the technology.
70-
Conceptual documents are helpful to explain the "why" of the technology.
71-
72-
An example of _Conceptual_ content would be describing the role
73-
of a Crossplane Provider.
74-
75-
_Procedural_ content is the step-by-step instructions to do something.
76-
Procedural content details the "how" of a piece of technology.
77-
78-
An example of a _Procedural_ document would be a step-by-step Crossplane
79-
installation guide.
80-
81-
User documentation is more narrowly focused on a single piece or
82-
related pieces of technology. For example, installing a Provider and creating a
83-
ProviderConfig.
84-
85-
Knowledge base articles are more "free-form" and can describe more than one
86-
piece of technology or provide more opinionated examples.
87-
88-
{{< hint "tip" >}}
89-
Not sure if the content would be better as a knowledge base article or user
90-
document? Ask in the `#documentation` channel of the
91-
[Crossplane Slack](https://slack.crossplane.io/).
92-
{{< /hint >}}
93-
9457
### Front matter
9558
Each page contains metadata called
9659
[front matter](https://gohugo.io/content-management/front-matter/). Each page

content/knowledge-base/_index.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

content/knowledge-base/guides/_index.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

content/knowledge-base/guides/composition-revisions.md

Lines changed: 0 additions & 136 deletions
This file was deleted.

content/knowledge-base/integrations/_index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

content/master/api/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Crossplane API
2+
title: API Reference
33
weight: 400
44
description: "API details for Crossplane's core types"
55
cascade:

content/master/cli/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
weight: 400
3-
title: Crossplane CLI
2+
weight: 200
3+
title: CLI Reference
44
description: "Documentation for the Crossplane command-line interface"
55
---
66

content/master/concepts/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Concepts
3-
weight: 100
3+
weight: 50
44
description: Understand Crossplane's core components
55
---
66

content/master/concepts/claims.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,4 @@ spec:
204204
name: my-claim-secret
205205
```
206206
207-
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
207+
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "connection-details">}}).

content/master/concepts/composite-resource-definitions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ recreate the XRD to change the `connectionSecretKeys`.
618618
{{</hint >}}
619619

620620
For more information on connection secrets read the
621-
[Connection Secrets knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
621+
[Connection Secrets knowledge base article]({{<ref "connection-details">}}).
622622

623623
### Set composite resource defaults
624624
XRDs can set default parameters for composite resources and Claims.

0 commit comments

Comments
 (0)