Windup Product Documentation
Overview
This repository holds the official documentation for Windup. These Windup guides are published on the Red Hat Customer Portal.
For developer-focused documentation, see the Windup wiki.
Contribute
See the Windup Documentation Contributing Guide for information on how to contribute to this repository.
Report a Documentation Bug
To log an issue against the Windup documentation, open a Windup JIRA with the Component field set to Documentation.
Repository Structure
This repository uses the following directory structure:
. ├── CONTRIBUTING.adoc (Guide for how to contribute to this repository) ├── README.adoc (This file) ├── docs/ (Contains all the asciidoc topics and top level content spec) │ ├── GUIDE_NAME/ │ │ ├── master.adoc (Base AsciiDoc file for this guide) │ │ ├── master-docinfo.xml (Metadata about this guide) │ │ ├── buildGuide.sh (Script to build this guide) │ │ ├── topics (Symbolic link to docs/topics/) │ ├── topics/ │ │ │ ├── images/ (Contains all images) │ │ │ │ ├── *.png │ │ │ ├── templates/ (AsciiDoc templates to be used across guides) │ │ │ │ ├── document-attributes.adoc (Stores attributes used across guides) │ │ │ │ ├── revision-info.adoc (Revision timestamp to be added to all guides) │ │ │ ├── *.adoc (AsciiDoc files used across guides) ├── legacy/ (Holds legacy scripts and files that are no longer used) └── scripts/ (Contains scripts to automate the processes used to create and build documentation) └── buildGuides.sh (Builds all top-level guides that are in the docs/ folder)