Skip to content

Commit

Permalink
init docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Manuel Sopena Ballesteros committed Jul 1, 2024
1 parent 87ac564 commit 43296c4
Show file tree
Hide file tree
Showing 61 changed files with 1,223 additions and 7,961 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: docs
on:
push:
branches:
- master
- main
- docs
- gh-pages
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name = "manta"
description = "Another CLI for basic/simple Shasta operations"
version = "1.37.0"
license-file = "LICENSE"
documentation = "https://github.com/eth-cscs/manta/blob/main/README.md"
documentation = "https://eth-cscs.github.io/manta"
homepage = "https://github.com/eth-cscs/manta/blob/main/README.md"
repository = "https://github.com/eth-cscs/manta"
keywords = ["cli", "Cray Management System", "productivity"]
Expand All @@ -16,8 +16,8 @@ publish = false # cargo
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
mesa = "0.37.7"
# mesa = { path = "../mesa" } # Only for development purposes
# mesa = "0.37.7"
mesa = { path = "../mesa" } # Only for development purposes
strum = "0.25.0"
strum_macros = "0.25"
chrono = "0.4.31"
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# MANTA
# Wellcome to Manta

Another CLI tool for [Alps](https://www.cscs.ch/science/computer-science-hpc/2021/cscs-hewlett-packard-enterprise-and-nvidia-announce-worlds-most-powerful-ai-capable-supercomputer).

Manta is a frontend cli to interact with Shasta, it uses [mesa](https://crates.io/crates/mesa) for all Shasta interaction.
Manta is a frontend cli to interact and extend CSM, it uses [mesa](https://github.com/eth-cscs/mesa) as a backend to interact with CSM.

Manta's goals:

- release operators from repetitive tasks.
- provide quick system feedback.
- Release operators from repetitive tasks.
- Provide quick system feedback.
- Simplify CICD pipelines

Manta aggregates information from multiple sources:

- Shasta Keycloak
- Shasta API
- Shasta K8s API
- CSM Keycloak
- CSM API
- CSM K8s API
- local git repo
- Gitea API (Shasta VCS)
- Gitea API (CSM VCS)
- Hashicorp Vault

## Features
Expand Down Expand Up @@ -394,3 +395,4 @@ cargo run -r --features dhat-heap -- get session
##### View results (dhat-heap.json file)

https://nnethercote.github.io/dh_view/dh_view.html

268 changes: 0 additions & 268 deletions doc/404.html

This file was deleted.

Binary file removed doc/assets/images/favicon.png
Binary file not shown.
Loading

0 comments on commit 43296c4

Please sign in to comment.