Skip to content

Commit 97480a1

Browse files
authored
Merge pull request #3872 from xrstf/fix-docs-banner
Improve version banner in our docs
2 parents ec40367 + 58c9b0d commit 97480a1

28 files changed

+215
-280
lines changed

docs/content/GOALS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Not every idea below may bear fruit, but it's never the wrong time to look for n
4444

4545
Finally, the bar is still high to writing controllers. Lowering the friction of automation and integration is in everyone's benefit - whether that's a bash script, a Terraform configuration, or custom SRE services. If we can reduce the cost of both infrastructure as code and new infrastructure APIs we can potentially make operational investments more composable.
4646

47-
See the [investigations doc for minimal API server](./developers/investigations/minimal-api-server.md) for more on
47+
See the [investigations doc for minimal API server](./developers/investigations/minimal-api-server.md) for more on
4848
improving the composability of the Kube API server.
4949

5050

@@ -79,4 +79,3 @@ Principles are the high level guiding rules we'd like to frame designs around. T
7979
6. Consolidate efforts in the ecosystem into a more focused effort
8080

8181
Kubernetes is mature and changes to the core happen slowly. By concentrating use cases among a number of participants we can better articulate common needs, focus the design time spent in the core project into a smaller set of efforts, and bring new investment into common shared problems strategically. We should make fast progress and be able to suggest high-impact changes without derailing other important Kubernetes initiatives.
82-

docs/content/concepts/apis/admission-webhooks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ flowchart TD
1414
schema["Widgets APIResourceSchema<br/>(widgets.v1.example.org)"]
1515
webhook["Mutating/ValidatingWebhookConfiguration<br/>ValidatingAdmissionPolicy<br/>for widgets.v1.example.org<br/><br/>Handle a from ws2 (APIResourceSchema)<br/>Handle b from ws3 (APIResourceSchema)<br/>Handle a from ws1 (CRD)"]
1616
crd["Widgets CustomResourceDefinition<br/>(widgets.v1.example.org)"]
17-
17+
1818
export --> schema
1919
schema --> webhook
2020
webhook --> crd
@@ -64,7 +64,7 @@ Consider a scenario where:
6464
- An `APIExport` for `cowboys.wildwest.dev`
6565
- A `ValidatingAdmissionPolicy` that rejects cowboys with `intent: "bad"`
6666
- A `ValidatingAdmissionPolicyBinding` that binds the policy
67-
67+
6868
- **Consumer workspace** (`root:consumer`) has:
6969
- An `APIBinding` that binds to the provider's `APIExport`
7070
- A user trying to create a cowboy with `intent: "bad"`

docs/content/concepts/apis/rest-access-patterns.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ This describes the various REST access patterns the kcp apiserver supports.
1111

1212
These requests are all prefixed with `/clusters/<workspace path | logical cluster name>`. Here are some example URLs:
1313

14-
- `GET /clusters/root/apis/tenancy.kcp.io/v1alpha1/workspaces` - lists all kcp Workspaces in the
14+
- `GET /clusters/root/apis/tenancy.kcp.io/v1alpha1/workspaces` - lists all kcp Workspaces in the
1515
`root` workspace.
1616
- `GET /clusters/root:compute/api/v1/namespaces/test` - gets the namespace `test` from the `root:compute` workspace
17-
- `GET /clusters/yqzkjxmzl9turgsf/api/v1/namespaces/test` - same as above, using the logical cluster name for
17+
- `GET /clusters/yqzkjxmzl9turgsf/api/v1/namespaces/test` - same as above, using the logical cluster name for
1818
`root:compute`
1919

2020
## Typical requests for resources through the APIExport virtual workspace
2121

22-
An APIExport provides a view into workspaces that contain APIBindings that are bound to the APIExport. This allows
23-
the service provider - the owner of the APIExport - to access data in its consumers' workspaces. Here is an example
22+
An APIExport provides a view into workspaces that contain APIBindings that are bound to the APIExport. This allows
23+
the service provider - the owner of the APIExport - to access data in its consumers' workspaces. Here is an example
2424
APIExport virtual workspace URL:
2525

2626
```
@@ -39,13 +39,13 @@ Let's break down the segments in the URL path:
3939

4040
## Setting up shared informers for a virtual workspace
4141

42-
A virtual workspace typically allows the service provider to set up shared informers that can list and watch
43-
resources across all the consumer workspaces bound to or supported by the virtual workspace. For example, the
44-
APIExport virtual workspace lets you inform across all workspaces that have an APIBinding to your APIExport. The
45-
syncer virtual workspace lets a syncer inform across all workspaces that have a Placement on the syncer's associated
42+
A virtual workspace typically allows the service provider to set up shared informers that can list and watch
43+
resources across all the consumer workspaces bound to or supported by the virtual workspace. For example, the
44+
APIExport virtual workspace lets you inform across all workspaces that have an APIBinding to your APIExport. The
45+
syncer virtual workspace lets a syncer inform across all workspaces that have a Placement on the syncer's associated
4646
SyncTarget.
4747

48-
To set up shared informers to span multiple workspaces, you use a special cluster called the **wildcard cluster**,
48+
To set up shared informers to span multiple workspaces, you use a special cluster called the **wildcard cluster**,
4949
denoted by `*`. An example URL you would use when constructing a shared informer in this manner might be:
5050

5151
```

docs/content/concepts/quickstart-tenancy-and-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ NAME TYPE PHASE URL
108108
b universal Ready https://myhost:6443/clusters/root:a:b
109109
```
110110

111-
Here is a quick collection of commands showing the navigation between the workspaces you've just created.
111+
Here is a quick collection of commands showing the navigation between the workspaces you've just created.
112112
Note the usage of `..` to switch to the parent workspace and `-` to the previously selected workspace.
113113

114114
```console

docs/content/concepts/sharding/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
## Pages
44

55
{% include "partials/section-overview.html" %}
6-

docs/content/concepts/workspaces/mounts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ root/
5656
└── org1/
5757
├── project-a/ # Traditional LogicalCluster workspace
5858
│ ├── LogicalCluster object # ✓ Has backing logical cluster
59-
│ ├── /api/v1/configmaps # ✓ Served by kcp directly
59+
│ ├── /api/v1/configmaps # ✓ Served by kcp directly
6060
│ └── /api/v1/secrets # ✓ Standard Kubernetes APIs
6161
6262
└── project-b/ # Mounted workspace
@@ -119,7 +119,7 @@ While the mount object can be any Custom Resource, you still need a controller t
119119
- Implement and run the actual API server/proxy that serves requests at the `status.URL`
120120
- Handle authentication, authorization, and any request filtering if needed
121121

122-
The kcp mounting machinery handles the workspace-to-mount routing, but the actual API implementation is entirely up to you.
122+
The kcp mounting machinery handles the workspace-to-mount routing, but the actual API implementation is entirely up to you.
123123

124124
### Creating a Mounted Workspace
125125

@@ -141,7 +141,7 @@ spec:
141141
#### Mount Field Requirements
142142

143143
- `ref.apiVersion`: The API version of the mount object
144-
- `ref.kind`: The kind of the mount object
144+
- `ref.kind`: The kind of the mount object
145145
- `ref.name`: The name of the mount object
146146
- `ref.namespace`: (Optional) The namespace of the mount object if it's namespaced
147147

@@ -238,4 +238,4 @@ The workspace mounts controller (`kcp-workspace-mounts`) manages the integration
238238

239239
## References
240240

241-
1. https://github.com/kcp-dev/contrib/tree/main/20241013-kubecon-saltlakecity/mounts-vw - Example mount controller and proxy implementation
241+
1. https://github.com/kcp-dev/contrib/tree/main/20241013-kubecon-saltlakecity/mounts-vw - Example mount controller and proxy implementation

docs/content/concepts/workspaces/workspace-termination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,5 +106,5 @@ You can use this url to construct a kubeconfig for your controller. To do so, us
106106

107107
When writing a custom terminator controller, the following needs to be taken into account:
108108

109-
* We strongly recommend to use [multicluster-runtime](github.com/kcp-dev/multicluster-runtime) to build your controller in order to properly handle which `LogicalCluster` originates from which workspace
109+
* We strongly recommend to use [multicluster-runtime](https://github.com/kcp-dev/multicluster-runtime) to build your controller in order to properly handle which `LogicalCluster` originates from which workspace
110110
* You need to update `LogicalClusters` using patches; They cannot be updated using the update api

docs/content/contributing/continuous-integration/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,3 @@ Then, to have your test use that shared kcp server, you add `-args --use-default
5656
```shell
5757
go test ./test/e2e/apibinding -count 20 -failfast -args --use-default-kcp-server
5858
```
59-

0 commit comments

Comments
 (0)