# Website sync configuration

This directory includes the configuration for syncing/curating contents from
specific Tekton repositories to the Tekton website.

The configuration is structure as follows:

```yaml
# The name of the component.
# sync.py will use this value to build directories in content/ and vault/.
component: <Component>
# The order of the component in the documentation.
displayOrder: 0
# The GitHub repository where documentation resides.
repository: https://github.com/tektoncd/<component>
# The directory in the GitHub repository where contents reside.
docDirectory: docs
# The link to the GitHub tag page.
archive: https://github.com/tektoncd/<component>/tags
# The tags (versions) of contents to sync.
# Note that sync.py and related script reads tags in the order specified in
# the following list; the first entry in tags will automatically become the
# latest version of contents.
# To add a new version, append to the list as below
tags:
- name: vX.Y.Z               # The first tag in the least is considered latest
  displayName: vX.Y.Z
  folders:
    docs:
      target: ''             # optional, default value ''
      index: README.md       # optional, if _index.md exists
      include: ['*.md']      # optional, default value ['*']
      exclude: ['not_in.md'] # optional, default value []
      header: <dict>         # optional, no header added if not set
        See https://www.docsy.dev/docs/adding-content/navigation/#section-menu
    other:
      target: 'other'        # optional, default value ''
      index: README.md       # optional, if _index.md exists
      include: ['*.md']      # optional, default value ['*']
      exclude: ['not_in.md'] # optional, default value []
      header: <dict>         # optional, no header added if not set
        See https://www.docsy.dev/docs/adding-content/navigation/#section-menu
- name: vX.Z.Z               # The first tag in the least is considered latest
  displayName: vX.Z.Z
  folders:
    docs:
      target: ''             # optional, default value ''
      index: README.md       # optional, if _index.md exists
      include: ['*.md']      # optional, default value ['*']
      exclude: ['not_in.md'] # optional, default value []
      header: <dict>         # optional, no header added if not set
        See https://www.docsy.dev/docs/adding-content/navigation/#section-menu
```

See `pipelines.yaml` for more inline instructions.
These two YAML files control the synchronization/curation from the `tektoncd/pipeline`
and `tektoncd/triggers` repositories respectively.

The YAML files here are used by the scripts in `../sync`.
