Skip to content

[Docs] Create user docs for multi-tenancy #3545

@melissahenderson

Description

@melissahenderson

Going forward, Rafiki will contain multi-tenancy by default. We need to create the user docs for the feature.

Rafiki Starlight needs to support versioned docs. I don't know the numbers yet, but old Rafiki that doesn't have MT is one version, and Rafiki with MT is another version. HJ ran into issues with adding versions, so we're waiting for help from Starlight Dude.

I'm only guessing at this point but it's likely that we'll need:

  • A new concepts page (i'm the least sure about this one at the moment)
  • A new integrations > requirements page
  • Updates to the Backend and Frontend Services pages, or at the very least, the environment variables tables
  • Updates to the admin user guide including screenshots
  • Updates to the glossary
  • Maybe webhook-related doc
  • Update to resources > architecture and/or new architecture diagrams

The API specs seem to already have MT-related details. We need to make sure that the old Rafiki docs don't contain these references.

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Backlog

Status

Ready for Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions