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

Git pages #361

Merged
merged 4 commits into from
May 14, 2019
Merged

Git pages #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22a210e
initial draft mbt docs
ShimiT May 13, 2019
5281e4c
initial draft mbt docs
ShimiT May 13, 2019
88ddc9c
initial draft mbt docs
ShimiT May 14, 2019
89292f2
initial draft mbt docs
ShimiT May 14, 2019
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
0 _config.yml → docs/_config.yml
View file
Open in desktop
File renamed without changes.
10 changes: 0 additions & 10 deletions docs/docs/description.md
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion docs/docs/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

There are two supported ways to install the multi-target application archive builder (MBT) tool:

**Manually**:
**Install manually**:

1. [Download](https://github.com/SAP/cloud-mta-build-tool/releases) the **latest** binary file according to your operating system.
2. Extract the archive file to the folder where you want to install the tool.
3. Add the binary file to your `~/bin` path according to your operating system:
Expand Down
18 changes: 10 additions & 8 deletions docs/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Welcome to the Cloud MTA Build Tool
# <b>Welcome to the Cloud MTA Build Tool </b>

## Introduction
## <b>Introduction</b>

Multi-Target Application (MTA) build tool for Cloud Applications

The Multi-target Application Archive Builder is a standalone command-line tool that builds a deployment-ready
multi-target application (MTA) archive `.mtar` file from the artifacts of an MTA project according to the project’s MTA
development descriptor (`mta.yaml` file) or from module build artifacts according to the MTA deployment descriptor (`mtad.yaml` file).

### <b> Multi-Target Application</b>

Before using this package, be sure you are familiar with the multi-target application concept and terminology.
For background and detailed information, see the [Multi-Target Application Model](https://www.sap.com/documents/2016/06/e2f618e4-757c-0010-82c7-eda71af511fa.html) guide.

- Description
- Usage
- Makefile
- Roadmap
- Download
5 changes: 3 additions & 2 deletions docs/docs/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@
- [ ] Partially supports the advanced `mta.yaml` (3.1 > 3.2) schema.


### Milestone 3 - (Q3 - 2019)
### Milestone 3 - (Q3 - 2019)


- [ ] Supports parallel execution for the default `Makefile` file.
- [ ] Supports incremental builds; in other words, one module at a time.

### Milestone 4 - (Q3 - 2019)
### Milestone 4 - (Q3 - 2019)

- [ ] Supports the extensibility framework.
- [ ] Fully supports the advanced `mta.yaml` (3.1 > 3.2) schema.
12 changes: 5 additions & 7 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
site_name: Cloud MTA Build Tool
repo_url: https://github.com/SAP/cloud-mta-build-tool
docs_dir: /docs/docs/
nav:
- Home: 'index.md'
- Description: 'description.md'
- Usage: 'usage.md'
- Makefile: 'makefile.md'
- Roadmap: 'roadmap.md'
- Download: 'download.md'
- Home: index.md
- Usage: usage.md
- Makefile: makefile.md
- Roadmap: roadmap.md
- Download: download.md

theme:
name: 'material'
Expand Down