This repository contains the files for Windup documentation.
Windup is an automated application migration and assessment tool.
For developer-focused documentation, see the Windup wiki.
This project is Apache 2.0 licensed and accepts contributions via GitHub pull requests.
See the Contributors Guide for details.
To report a Windup documentation issue, submit a Jira issue on the [Windup project page]]{JiraWindupURL} with the Component field set to Documentation.
This repository uses the following directory structure:
.
βββ CONTRIBUTING.adoc (Guide for how to contribute to this repository)
βββ README.md (This file)
βββ topics (Symbolic link to docs/topics/)
βββ 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)
βΒ Β βββ 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)