Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Updates to README.md #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] Updates to README.md #5

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0742ed
Initial readme updates
mpershina Jun 24, 2024
d45a13a
Update README.md
mpershina Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,31 @@

# Windup Documentation
# MTA documentation

This repository contains the files for Windup documentation.

[Windup](https://github.com/windup/windup) is an automated application migration and assessment tool.
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.

For developer-focused documentation, see the [Windup wiki](https://github.com/windup/windup/wiki).
This repository contains the files for Windup documentation.
mpershina marked this conversation as resolved.
Show resolved Hide resolved

## Contributing to Windup documentation
## Contributing to MTA documentation

This project is [Apache 2.0 licensed](LICENSE) and accepts contributions via
GitHub pull requests.
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*.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have something similar for this case?


## Repository Structure
## Repository structure

This repository uses the following directory structure:
This repository has the following directory structure:

```
.
├── CONTRIBUTING.adoc (Guide for how to contribute to this repository)
├── CONTRIBUTING.adoc (Instructions on 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/
├── guide_name/
│   ├── master.adoc (Base AsciiDoc file for this guide)
│   ├── master-docinfo.xml (Metadata about this guide)
│   └── topics (Symbolic link to docs/topics/)
Expand All @@ -39,7 +36,7 @@ This repository uses the following directory structure:
│   ├── 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

Expand Down