Skip to content

Commit

Permalink
feat: mkdocs for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dwinston committed Nov 2, 2021
1 parent ecf73f5 commit e4bc1d4
Show file tree
Hide file tree
Showing 15 changed files with 58 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: mkdocs
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
17 changes: 17 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

How to contribute to this documentation.

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Welcome

Welcome to the documentation for the nmdc-runtime system.
4 changes: 4 additions & 0 deletions docs/jobs/emsl-translation-etl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# EMSL Translation ETL


This job takes a `nmdc_merged_data.tsv.zip` file as a data object input.
4 changes: 4 additions & 0 deletions docs/jobs/gold-translation-etl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# GOLD Translation ETL


This job takes a `nmdc_merged_data.tsv.zip` file as a data object input.
4 changes: 4 additions & 0 deletions docs/jobs/jgi-translation-etl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# JGI Translation ETL


This job takes a `nmdc_merged_data.tsv.zip` file as a data object input.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
11 changes: 11 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
site_name: nmdc-runtime docs
site_url: https://microbiomedata.github.io/nmdc-runtime/
theme:
name: material
nav:
- index.md
- Jobs:
- jobs/emsl-translation-etl.md
- jobs/gold-translation-etl.md
- jobs/jgi-translation-etl.md
- contributing.md

0 comments on commit e4bc1d4

Please sign in to comment.