https://github.com/windup/windup-documentation
Windup Documentation
https://github.com/windup/windup-documentation
documentation
Last synced: 3 months ago
JSON representation
Windup Documentation
- Host: GitHub
- URL: https://github.com/windup/windup-documentation
- Owner: windup
- License: apache-2.0
- Created: 2014-03-25T17:39:41.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T01:12:16.000Z (7 months ago)
- Last Synced: 2024-10-30T03:53:06.060Z (7 months ago)
- Topics: documentation
- Language: HTML
- Homepage: https://windup.github.io/windup-documentation/
- Size: 43.8 MB
- Stars: 8
- Watchers: 10
- Forks: 31
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.adoc
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Windup Documentation
This repository contains the files for Windup documentation.
[Windup](https://github.com/windup/windup) is an automated application migration and assessment tool.
For developer-focused documentation, see the [Windup wiki](https://github.com/windup/windup/wiki).
## Contributing to Windup documentation
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via
GitHub pull requests.
See the [Contributors Guide](CONTRIBUTING.adoc) 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
[](CODE_OF_CONDUCT.md)
## PR preview rendering
[](https://www.netlify.com)