Skip to content

Commit d0742ed

Browse files
committed
Initial readme updates
1 parent 5c9bfbf commit d0742ed

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,31 @@
11

2-
# Windup Documentation
2+
# MTA documentation
33

4-
This repository contains the files for Windup documentation.
5-
6-
[Windup](https://github.com/windup/windup) is an automated application migration and assessment tool.
4+
Migration Toolkit for Applications (MTA) is a set of tools that can be used to accelerate large-scale application modernization efforts across hybrid cloud environments on Red Hat OpenShift.
75

8-
For developer-focused documentation, see the [Windup wiki](https://github.com/windup/windup/wiki).
6+
This repository contains the files for Windup documentation.
97

10-
## Contributing to Windup documentation
8+
## Contributing to MTA documentation
119

12-
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via
13-
GitHub pull requests.
10+
This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.
1411

1512
See the [Contributors Guide](CONTRIBUTING.adoc) for details.
1613

1714
## Reporting a documentation bug
1815

1916
To report a Windup documentation issue, submit a Jira issue on the [Windup project page]]{JiraWindupURL} with the *Component* field set to *Documentation*.
2017

21-
## Repository Structure
18+
## Repository structure
2219

23-
This repository uses the following directory structure:
20+
This repository has the following directory structure:
2421

2522
```
2623
.
27-
├── CONTRIBUTING.adoc (Guide for how to contribute to this repository)
24+
├── CONTRIBUTING.adoc (Instructions on how to contribute to this repository)
2825
├── README.md (This file)
2926
├── topics (Symbolic link to docs/topics/)
3027
└── docs/ (Contains all the asciidoc topics and top level content spec)
31-
├── GUIDE_NAME/
28+
├── guide_name/
3229
│   ├── master.adoc (Base AsciiDoc file for this guide)
3330
│   ├── master-docinfo.xml (Metadata about this guide)
3431
│   └── topics (Symbolic link to docs/topics/)
@@ -39,7 +36,7 @@ This repository uses the following directory structure:
3936
│   ├── document-attributes.adoc (Stores attributes used across guides)
4037
│   ├── revision-info.adoc (Revision timestamp to be added to all guides)
4138
└── *.adoc (AsciiDoc files used across guides)
42-
```
39+
```
4340

4441
## Code of conduct
4542

0 commit comments

Comments
 (0)