Skip to content

Commit

Permalink
remove outdated docs and broken references; remove broken quickstart (#…
Browse files Browse the repository at this point in the history
…3670)

Signed-off-by: Dejan Zele Pejchev <[email protected]>
  • Loading branch information
dejanzele authored Jun 18, 2024
1 parent 5530e50 commit e4e896e
Show file tree
Hide file tree
Showing 42 changed files with 85 additions and 3,421 deletions.
24 changes: 0 additions & 24 deletions .devcontainer/demo/README.md

This file was deleted.

18 changes: 0 additions & 18 deletions .devcontainer/demo/devcontainer.json

This file was deleted.

24 changes: 0 additions & 24 deletions .devcontainer/demo/jobs.yaml

This file was deleted.

15 changes: 0 additions & 15 deletions .devcontainer/demo/start.sh

This file was deleted.

21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,33 @@ For an overview of Armada, see the following videos:

The Armada project adheres to the CNCF [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

## Installation

### Armada Operator

For installation instructions, easiest way is to use the Armada Operator.
For more information, see the [Armada Operator repository](https://github.com/armadaproject/armada-operator).

Alternatively, you can install Armada manually by using the Helm charts defined in the `deployment` directory.

### armadactl

Armada also provides a command-line interface, `armadactl`, which can be used to interact with the Armada system.

To install `armadactl`, run the following script:
```bash
scripts/get-armadactl.sh
```

Or download it from the [GitHub Release](https://github.com/armadaproject/armada/releases/latest) page for your platform.

## Documentation

For documentation, see the following:

- [System overview](./docs/system_overview.md)
- [Scheduler](./docs/scheduler.md)
- [User guide](./docs/user.md)
- [Quickstart](./docs/quickstart/index.md)
- [Development guide](./docs/developer.md)
- [Release notes/Version history](https://github.com/armadaproject/armada/releases)
- [API Documentation](./docs/developer/api.md)
Expand Down
23 changes: 0 additions & 23 deletions deployment/armada-bundle/.helmignore

This file was deleted.

33 changes: 0 additions & 33 deletions deployment/armada-bundle/Chart.lock

This file was deleted.

46 changes: 0 additions & 46 deletions deployment/armada-bundle/Chart.yaml

This file was deleted.

131 changes: 0 additions & 131 deletions deployment/armada-bundle/README.md

This file was deleted.

Loading

0 comments on commit e4e896e

Please sign in to comment.