Skip to content

anarnold97/windup-documentation

Β 
Β 

Repository files navigation

Windup Documentation

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.

Contributing to Windup documentation

This project is Apache 2.0 licensed and accepts contributions via GitHub pull requests.

See the Contributors Guide for details.

Reporting a documentation bug

To report a Windup documentation issue, submit a Jira issue on the [Windup project page]]{JiraWindupURL} 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.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)

Code of conduct

Contributor Covenant

PR preview rendering

Releases

No releases published

Packages

No packages published

Languages

  • HTML 95.7%
  • SCSS 4.0%
  • Other 0.3%