Update component.yml filename
component.yml
is the configuration file that must sit in each documentation component. This file tells Antora the following:
name: server <1>
title: Ultimate Server <2>
version: '5.0' <3>
nav:
- modules/introduction/nav.adoc <4>
- modules/getting-started/nav.adoc
- modules/administration/nav.adoc
<1> Name of the documentation component (input)
<2> Name to use in output
<3> Latest/stable version and label to use in output
<4> List of navigation files to process
We've decided that the name of this file (component.yml
), is too generic.
Tasks
- select new filename
- current proposals include
docs-component.yml
(which feels long) anddocs.yml
- update Antora to recognize new filename