Open Authoring

Open Authoring is a workflow that allows contributors to propose changes to a project without requiring direct write access to the repository. This is typically done through fork-and-pull request mechanisms, enabling a wider range of contributors to participate in content creation and editing.

Unimplemented

This feature is not yet supported in Sveltia CMS. It will be added in the near future.

Use Cases

• Open source projects that welcome contributions from the community.
• Projects that require a formal review process for external contributions.
• Situations where contributors may not have direct access to the main repository.
• Workflows that involve multiple stages of review and approval for external contributions.

Requirements

The GitHub backend must be used.

Future Plans

Support for other Git backends may be added in the future.

Configuration

Add the open_authoring option to your CMS configuration’s backend settings:

YAML

backend:
  name: github
  repo: user/repo
  open_authoring: true

TOML

[backend]
name = "github"
repo = "user/repo"
open_authoring = true

JSON

{
  "backend": {
    "name": "github",
    "repo": "user/repo",
    "open_authoring": true
  }
}

JavaScript

{
  backend: {
    name: 'github',
    repo: 'user/repo',
    open_authoring: true,
  },
}