Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
* @redpanda-data/documentation
* @redpanda-data/documentation

# Auto-add marketing as reviewers in partner integration page
modules/get-started/pages/partner-integration.adoc @redpanda-data/documentation @larsenpanda @mikebroberg @dunithd
# The enterprise features registry defines which features may be documented as
# enterprise and under what names. Changes need docs-team review.
/shared/modules/ROOT/partials/enterprise-features.yml @redpanda-data/documentation
5 changes: 4 additions & 1 deletion local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@ content:
sources:
- url: .
branches: HEAD
- url: .
branches: HEAD
start_path: shared
- url: https://github.com/redpanda-data/docs
branches: [v/*, shared, site-search,'!v-end-of-life/*']
branches: [v/*, site-search,'!v-end-of-life/*']
- url: https://github.com/redpanda-data/cloud-docs
branches: main
- url: https://github.com/redpanda-data/redpanda-labs
Expand Down
46 changes: 46 additions & 0 deletions shared/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
= Shared Component
:url-docs: https://docs.redpanda.com
:url-org: https://github.com/redpanda-data
:url-ui: {url-org}/docs-ui
:url-extensions: {url-org}/docs-extensions-and-macros
:hide-uri-scheme:
:url-contributing: {url-org}/docs-site/blob/main/meta-docs/CONTRIBUTING.adoc
:url-netlify: https://netlify.com
:url-netlify-docs: https://docs.netlify.com
:url-antora-docs: https://docs.antora.org
:url-redoc: https://github.com/Redocly/redoc
:idprefix:
:idseparator: -
ifdef::env-github[]
:important-caption: :exclamation:
:note-caption: :paperclip:
endif::[]
:toc:
:toc-title: Contents

toc::[]

This directory is the `shared` Antora component: content that is intended to be shared across all component versions and doc sites. It lives on `main` in the `shared/` folder and is added to each playbook as a separate content source with `start_path: shared`. (It previously lived on the now-retired `shared` branch.)

== Enterprise features registry

The `ROOT/partials/enterprise-features.yml` file is the canonical registry of enterprise features: which features are enterprise, their approved external names, and pointers to the internal source of truth for each. The {url-extensions}[`enterprise` macro] validates its targets against this registry, and the `enterprise_features` block macro renders the licensing feature tables from it. To mark a feature as enterprise anywhere in the docs, add an entry here first. See the comment header in the file for the field reference and governance rules.

== Global attributes

The attributes in the `ROOT/partials/global-attributes.yml` file are merged into the `antora.yml` file of each component version by the {url-extensions}[global attributes extension]. These global attributes are required for all local builds as well as the production build.

== Terms

The pages in the `terms/partials/` directory are terms that can be referenced in any component version using the {url-extensions}[`glossterm` macro]. The content of these term pages are also added automatically to `reference:glossary.adoc` pages by the {url-extensions}[aggregate terms extension].

Each partial file in the `terms/partials/` directory is a term. Each file must include the following attributes:

- `term-name`: The name of the term.
- `hover-text`: A short definition of the term to be used as hover-over text.

If a page called `reference:glossary.adoc` exists in a component version, the contents of each term file gets merged into the glossary during the build. Terms are merged in alphabetical order, according to the filename.

== Contributing

To learn how to use the playbook and generate the docs site locally, see our link:{url-contributing}[contributing guide].
6 changes: 6 additions & 0 deletions shared/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: shared
version: ~
asciidoc:
attributes:
page-hide-view-latest: true
page-exclude-from-dropdown-selector: true
Loading
Loading