Repository directory structure

Repository directory structure

.
|
├── downstream
│   ├── assemblies
│   │   ├── platform-component1
│   │   └── platform-component2
│   │        ├── assembly-title-1.adoc
│   │        ├── assembly-title-2.adoc
│   │        └── modules -> ../modules/
│   ├── attributes
│   ├── images
│   │   ├── image-1.png
│   │   └── image-2.png
│   ├── modules
│   │   ├── platform-component1
│   │   └── platform-component2
│   │       ├── module-title-1.adoc
│   │       └── module-title-2.adoc
|   ├── titles
│   │   ├── platform-component1
│   │   └── platform-component2
│   │        ├── title-1.adoc
│   │        ├── title-2.adoc
│   │        └── modules -> ../modules/
│   └── release-notes
└── README.adoc

Top-level directories are:

• downstream: A directory that stores the Red Hat Ansible Automation platform modules, assemblies, and titles.

Lower-level directories are:

• attributes: A common directory for attribute files.

• assemblies: A directory for all assemblies, each on in its own AsciiDoc file. Assemblies are collections of modules linked together.

  • Assemblies are grouped by platform component. Create a new subdirectory to organize assemblies associated with that component.

• images: A directory for all images and other digital content.

• modules: A directory for all modules, each one in its own AsciiDoc file.

  • Modules are grouped by platform component. Create a new subdirectory to organize modules associated with that component.

• titles: A directory for titles (information units, e.g, install guide, user guide). Contains master.adoc files to be called during builds and symbolic links to directories (modules, etc.) that contain .adoc content.

  • Titles are grouped by platform component or platform-level feature. Create a new subdirectory to organize titles associated with a component.