Skip to content

redpanda-data/docs

 
 

Repository files navigation

Shared Component

This branch contains content that is intended to be shared across all component versions.

Global attributes

The attributes in the ROOT/partials/attributes.yaml file are merged into the antora.yml file of each component version by the 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 glossterm macro. The content of these term pages are also added automatically to reference:glossary.adoc pages by the 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 contributing guide.

About

Open source content for the Redpanda documentation

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 75