Skip to content
This repository has been archived by the owner on Sep 19, 2024. It is now read-only.

Commit

Permalink
Moves docs out of readme and into mkdocs (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
djperrefort committed Jun 10, 2024
1 parent 4abb274 commit cb15e2e
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 37 deletions.
37 changes: 0 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,40 +9,3 @@ The frontend web interface for the Keystone allocation management dashboard.
- [Keystone-API](https://github.com/pitt-crc/keystone-api): Backend REST API for managing HPC allocations and resources.
- [Keystone-Web](https://github.com/pitt-crc/keystone-web): Website frontend for HPC administration and self-service.
- [Keystone-Docs](https://github.com/pitt-crc/keystone-docs): Documentation for the Keystone project and its components.

## Installation

To install the Keystone web interface, choose from one of the following options.

### Using Docker

Using Docker is the recommended method for building and deploying application instances in production.

The latest development version can be built directly from source:

```bash
git clone https://github.com/pitt-crc/keystone-web
docker build -t keystone-web:develop keystone-web
docker run -p 4200:4200 keystone-web:develop
```

### Using NPM

This project requires the Angular CLI utility.

```bash
npm install -g @angular/cli
```

Any remaining dependencies can be installed via `npm` in the standard fashion.

```bash
npm install
```

Build scripts are provided for building and serving a local instance of the application.

```bash
npm run build
npm run serve
```
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Keystone-Web

Keystone-Web is a graphical web interface built on top the [Keystone-API](../keystone-api) REST API.
It facilitates day-to-day administrative activities while empowering HPC user to self administrate common tasks.
36 changes: 36 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Installation

To install the Keystone web interface, choose from one of the following options.

## Using Docker

Using Docker is the recommended method for building and deploying application instances in production.

The latest development version can be built directly from source:

```bash
git clone https://github.com/pitt-crc/keystone-web
docker build -t keystone-web:develop keystone-web
docker run -p 4200:4200 keystone-web:develop
```

## Using NPM

This project requires the Angular CLI utility.

```bash
npm install -g @angular/cli
```

Any remaining dependencies can be installed via `npm` in the standard fashion.

```bash
npm install
```

Build scripts are provided for building and serving a local instance of the application.

```bash
npm run build
npm run serve
```
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
site_name: Keystone Web
nav:
- Introduction: index.md
- installation.md

0 comments on commit cb15e2e

Please sign in to comment.