Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
2276b99
Removes process scripts for CRDs, remove unused packages
tr0njavolta Jul 1, 2026
ebb6d52
Bootstrap hub documents
RedbackThomson Jul 9, 2026
a9e053c
Transpose documentation into this repository
RedbackThomson Jul 9, 2026
67e8d53
Update vale and rewrites
tr0njavolta Jul 20, 2026
05d0d2d
Add howtos for connecting spaces and control planes
branden Jul 17, 2026
edc633a
Fix overview reference to space cluster
branden Jul 17, 2026
528ba3e
Address review
branden Jul 17, 2026
93ce6c4
lint
branden Jul 17, 2026
f5bd195
Add screenshots
branden Jul 21, 2026
d801233
Update image links
tr0njavolta Jul 23, 2026
8a7fd94
[platform v3] Catalog documentation
jastang Jul 20, 2026
cdbf435
Add "Browsing the Catalog" docs page for the Console UI
thephred Jul 23, 2026
14cf781
new edits after feature flag refactoring
jastang Jul 24, 2026
990d94e
Vale pass
jastang Jul 24, 2026
3cd5d5b
remove API reference material in favour of dedicated docs.
jastang Jul 24, 2026
3a8d2ea
remove references to deleted reference.md
jastang Jul 24, 2026
9cbccc2
Update quickstarts
tr0njavolta Jul 27, 2026
5d5d89a
Add hub features Registry, Metrics, Agent Sessions, Insights
tr0njavolta Jul 29, 2026
1078ba2
docs(hub): fix stale values paths, document groupsClaim
tnthornton Jul 28, 2026
2cccc4d
docs(hub): document replacing the browser-login provider
tnthornton Jul 28, 2026
8a034dc
GLO-1380: Add documentation for lenses for GA
Fallenstedt Jul 30, 2026
b359996
docs(hub): build on the Metrics feature docs, move setup to Deploy
lsviben Jul 30, 2026
1a82128
Merge pull request #14 from lsviben/docs/hub-metrics
tr0njavolta Jul 30, 2026
d31efbc
Merge pull request #13 from Fallenstedt/GLO-1380
tr0njavolta Jul 30, 2026
3eb6bc8
Merge branch 'up-v3-docs' into hub-features
tr0njavolta Jul 30, 2026
f6e5346
Add 'Lenses' category and update 'Registry' type
tr0njavolta Jul 30, 2026
da95d6a
Add feature flag page
tr0njavolta Jul 30, 2026
355669c
Move connect docs to Deploy category
branden Jul 30, 2026
7e126e3
Add Hub docs for the Definitions and Packages features
thephred Jul 29, 2026
9f471a5
Correct the AggregatedTypes default and drop a gate that no longer ex…
thephred Jul 29, 2026
d1ba751
docs(hub): correct the tier cascade for realm to control plane
tnthornton Jul 30, 2026
18e6628
docs(hub): refresh RBAC API versions, identity, and control-plane setup
tnthornton Jul 30, 2026
2590408
Merge pull request #15 from branden/move-connect-docs-deploy
tr0njavolta Jul 30, 2026
84bd546
Remove project/up from quickstart
tr0njavolta Jul 30, 2026
9e02ad0
Merge remote-tracking branch 'refs/remotes/origin/up-v3-docs'
tr0njavolta Jul 30, 2026
db7a15c
Update features>insights
tr0njavolta Jul 30, 2026
fb14054
directory name update
tr0njavolta Jul 30, 2026
5f33bdb
Update sidebar
tr0njavolta Jul 30, 2026
358cd29
Merge pull request #12 from thephred/GLO-1379
tr0njavolta Jul 30, 2026
c9f6e49
Merge pull request #16 from tnthornton/hub-rbac-corrections
tr0njavolta Jul 30, 2026
d704360
Merge branch 'up-v3-docs' into hub-features
tr0njavolta Jul 30, 2026
121d56b
Delete hub-docs/howtos/enable-features.md
tr0njavolta Jul 30, 2026
dd0a92e
Update links and sidebar, remove unused components
tr0njavolta Jul 30, 2026
2b6d409
Merge pull request #10 from tr0njavolta/hub-features
tr0njavolta Jul 30, 2026
b451b26
docs(hub): base sizing guidance on tested resource counts
tnthornton Jul 30, 2026
7004753
Merge hub-oidc-groups-claim-v2 (PR #16: RBAC tier cascade correction …
tr0njavolta Jul 30, 2026
4139590
Merge pull request #18 from tnthornton/hub-sizing-measured
tr0njavolta Jul 30, 2026
52dd468
Restructure Insights as a product under Hub
RedbackThomson Jul 30, 2026
1e6bae6
Merge pull request #19 from RedbackThomson/push-nmqtrmsyymkz
tr0njavolta Jul 31, 2026
c57c71a
Update Hub Helm values reference (main) (#1235)
tr0njavolta Jul 31, 2026
e5b7a1e
Add Hub observability how-to under Production (#1237)
lsviben Jul 31, 2026
bc89b38
Up v3 docs (#1238)
tr0njavolta Jul 31, 2026
55273e6
Add three-part Hub quickstart
tr0njavolta Jul 31, 2026
d371611
Add kubectl how-to and fix Insights navigation links (#1239)
tr0njavolta Jul 31, 2026
5ca68d9
Update placement and version string (#1240)
tr0njavolta Jul 31, 2026
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
2 changes: 0 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
- Start local docs server: `npm start`
- Build documentation: `npm run build`
- Serve built documentation: `npm run serve`
- Process CRDs: `npm run process-crds`
- Clear Docusaurus cache: `npm run clear`
- Deploy documentation: `npm run deploy`
- Generate translations: `npm run write-translations`
Expand Down Expand Up @@ -38,5 +37,4 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
- This is a Docusaurus site, not Hugo
- Requires Node.js 18.x and npm 9.x
- Use `npm start` for local development with hot reloading
- CRDs are processed via script before start/build commands
- Site uses React components and MDX for enhanced functionality
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,24 @@ make build

All PRs require maintainer approval to merge, regardless of Vale status.

## Updating CRDs

CRD reference pages (`docs/reference/apis/*`) render live from raw CRD YAML
files committed under `static/crds/<product>/`. There's no generation step —
Docusaurus serves `static/` files as-is, and the `CrdDocViewer` component
fetches the YAML client-side by URL:

```mdx
<CrdDocViewer crdUrl="/crds/testing/meta.dev.upbound.io_compositiontests.yaml" />
```

To add or update a CRD:

1. Copy the CRD's YAML file from its source repo (UXP, Crossplane, Spaces,
etc.) into the matching `static/crds/<product>/` directory.
2. Reference it from the relevant page with `<CrdDocViewer crdUrl="/crds/..." />`.
3. Commit the YAML file alongside your doc changes in the same PR.

## VSCode Setup (Recommended)

For the best documentation editing experience, install these extensions:
Expand Down
9 changes: 3 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ VALE_BINARY := vale_$(VALE_VERSION)_$(VALE_OS)_$(VALE_ARCH).tar.gz
VALE_INSTALL_DIR := ./bin
VALE_EXEC := $(VALE_INSTALL_DIR)/vale

.PHONY: help install-vale vale vale-docs vale-file vale-summary clean build start serve process-crds
.PHONY: help install-vale vale vale-docs vale-file vale-summary clean build start serve

# Default target
help: ## Show this help message
Expand All @@ -46,7 +46,7 @@ help: ## Show this help message
install: ## Install dependencies
npm install

build: process-crds ## Build the documentation site
build: ## Build the documentation site
npm run build

start: ## Start local development server
Expand All @@ -55,9 +55,6 @@ start: ## Start local development server
serve: ## Serve built documentation
npm run serve

process-crds: ## Process CRDs for documentation
npm run process-crds

# Vale installation and linting commands
install-vale: ## Install Vale binary locally
@echo "Installing Vale $(VALE_VERSION) for $(VALE_OS) $(VALE_ARCH)..."
Expand Down Expand Up @@ -130,7 +127,7 @@ dev: install start ## Install dependencies and start development server

# CI/CD targets
ci-lint: install-vale vale-summary ## Run linting for CI/CD pipeline
ci-build: install process-crds build ## Build for CI/CD pipeline
ci-build: install build ## Build for CI/CD pipeline

# Version info
version: ## Show versions of tools
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,9 @@ make check-vale-config
| Command | Description |
|---------|-------------|
| `make install` | Install npm dependencies |
| `make build` | Build the documentation site (includes CRD processing) |
| `make build` | Build the documentation site |
| `make start` | Start local development server with hot reload |
| `make serve` | Serve the built documentation |
| `make process-crds` | Process Custom Resource Definitions for documentation |
| `make dev` | Install dependencies and start development server |
| `make ci-build` | Full build process for CI/CD |

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Upgrade to Spaces
sidebar_position: 3
sidebar_position: 4
description: A guide to how to update to a control plane in an Upbound Space
---

Expand Down
2 changes: 1 addition & 1 deletion docs/getstarted/builders-workshop/1-project-foundations.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ you want to apply to this `StorageBucket` resource.

Paste this XR into your XR file:

<Tabs>
<Tabs groupId="cloud-provider">
<TabItem value="aws" label="AWS">

```yaml title="upbound-hello-world/examples/storagebucket/example.yaml"
Expand Down
Loading
Loading