Skip to content

Versioned spaces#1070

Open
tr0njavolta wants to merge 29 commits intomainfrom
versioned-spaces
Open

Versioned spaces#1070
tr0njavolta wants to merge 29 commits intomainfrom
versioned-spaces

Conversation

@tr0njavolta
Copy link
Member

@tr0njavolta tr0njavolta commented Jan 29, 2026

Description

#1029
This PR attempts to address the issue of Spaces versioning. This creates a multi-site instance for the Spaces docs to avoid confusion with UXP versioning.

The multi-site implementation is in line with what Docusaurus recommends for distinct sets docs (UXP vs Spaces in this case) https://docusaurus.io/docs/docs-multi-instance

Type of change

  • Bug fix (typo, broken link, incorrect info)
  • Content update (new info, clarification, reorganization)
  • New content (new page, section, or guide)

Checklist

  • I ran make lint locally (or will fix Vale suggestions in review)
  • Links work and point to the right places
  • If this adds new content, I tested the examples/instructions

Additional notes

@vercel
Copy link

vercel bot commented Jan 29, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 18, 2026 8:21pm

Request Review

@tr0njavolta
Copy link
Member Author

Todo:

  • Breadcrumbs in Spaces site with better navigation back to "Home"

Copy link
Contributor

@cbuto cbuto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started going through 1.13 docs and noted somethings I found. Some of it might apply to other versions as well.

I still need to go through more but its a lot 😄


## Shared backups

As of Spaces `v.12.0`, this feature is enabled by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can prob drop this reference to 1.12 and just state its enabled by default

---

:::important
This feature is in preview. Starting in Spaces `v1.8.0` and later, you must
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can drop the references to 1.8

}
```

For more information about workload identities, review the [Workload-identity
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

definitely some overlap with the workload ID doc for billing here. In the future, we should probably combine or maybe even remove https://docs.upbound.io/manuals/spaces/howtos/self-hosted/workload-id/billing-config/


Spaces supports the three [preceding minor versions][preceding-minor-versions] from the last supported minor version. example, if the last supported minor version is `1.14`, minor versions `1.13` and `1.12` are also supported. Versions older than the three most recent minor versions aren't supported. Only supported Crossplane versions are valid specifications for new control planes.

Current Crossplane version support by Spaces version:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh man this is out of date lol, maybe we just drop this in all docs versions

@tr0njavolta tr0njavolta marked this pull request as ready for review March 18, 2026 17:52
Copy link
Contributor

@cbuto cbuto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still have a lot to go through but this is looking really great @tr0njavolta!

:::

:::note
Control Plane Topologies is not yet available for Cloud Spaces. This feature is currently available for Connected and Disconnected (Self-Hosted) Spaces only.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can remove this from cloud spaces docs

In this tutorial, you learn how to configure a Kubernetes app cluster to communicate with a control plane in an Upbound Space.


The [control plane connector][control-plane-connector] bridges your Kubernetes application clusters---running outside of Upbound--to your control planes running in Upbound. This allows you to interact with your control plane's API right from the app cluster. The claim APIs you define via `CompositeResourceDefinitions` are available alongside Kubernetes workload APIs like `Pod`. In effect, control plane connector provides the same experience as a locally installed Crossplane.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doc and cloud-spaces-docs/howtos/ctp-connector.md both cover MCP connector but a bit different 🤔. we could probably combine them or just remove one?

@@ -0,0 +1,412 @@
---
title: Disaster Recovery
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

organizationally, disaster recovery should be a top level topic and under should be SpaceBackups and SharedBackups

To enable it on versions earlier than `v1.14.0`, set features.alpha.spaceBackup.enabled=true when you install Spaces.

```bash
up space init --token-file="${SPACES_TOKEN_PATH}" "v${SPACES_VERSION}" \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one thought for future us:

most users are likely not using up space init when managing Spaces, so having docs focus more on configuration of an existing Space vs full end to end install would make things less complicated and more concise. Not something we should tackle now but i noticed it going through a lot of these docs.

@@ -0,0 +1,164 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find a good spot to comment this but having Connect as a high level topic might be confusing.

When we discuss connect in the context of Spaces, we typically are referencing:

https://docs-git-versioned-spaces-upboundio.vercel.app/self-hosted-spaces/howtos/attach-detach/

I'm unsure if api connector/mcp connector don't necessarily belong with Query API.

Connect as a high level topic would be:

  • connecting a Space
  • Query API

The self-hostee MCP connector docs also still reference cloud, which we can remove.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants