Skip to content

Updated ReadMe #6

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

Merged
Pkylas007 merged 1 commit into from
Mar 11, 2025
Merged

Updated ReadMe #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 28 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,50 @@
// we will need to write a new README.md for the new repo
# MTA Documentation

Prabha blah blah blah blah blah
# Windup Documentation

Prabha blah blah blah blah blah
This repository contains the files for Windup documentation.

Prabha blah blah blah blah blah
[Windup](https://github.com/windup/windup) is an automated application migration and assessment tool.

Prabha blah blah blah blah blah
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:

Prabha blah blah blah blah blah
```
.
├── CONTRIBUTING.adoc (Guide for how to contribute to this repository)
Prabha blah blah blah blah blah
├── README.md (This file)
├── topics (Symbolic link to docs/topics/)
└── docs/ (Contains all the asciidoc topics and top level content spec)
Prabha blah blah blah blah blah
├── 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)
├── Prabha blah blah blah blah blah
├── Prabha blah blah blah blah blah
│   ├── 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](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)

## PR preview rendering

[![](https://www.netlify.com/img/global/badges/netlify-light.svg)](https://www.netlify.com)