Skip to content

Commit

Permalink
Convert documentation to use new style and TOC (#70)
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpalmer authored Oct 21, 2019
1 parent 0f28938 commit 6dfdde5
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 39 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,6 @@ indent_size = 2

[*.md]
trim_trailing_whitespace = false

[*.yml]
indent_size = 2
16 changes: 9 additions & 7 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,15 @@ github_url: https://github.com/ubccr/xdmod-appkernels
xdmod_module_name: Application Kernels

defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
menu_markdown: "menu.md"
-
scope:
path: ""
type: "pages"
values:
layout: "page"
sw_version: "8.5.0"
style: "effervescence"
tocversion: "toc"

# Build settings
markdown: kramdown
Expand Down
36 changes: 36 additions & 0 deletions docs/_data/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
toc:
- title: About
subfolderitems:
- page: Overview
url: /ak-overview.html
- title: Download
subfolderitems:
- page: Open XDMoD module
url: https://github.com/ubccr/xdmod-appkernels/releases/latest
- page: AKRR package
url: https://github.com/ubccr/akrr/releases/latest
- title: Installing
subfolderitems:
- page: Installation Guide
url: /ak-install.html
subsubfolderitems:
- page: RPM Installation Guide
url: /ak-install-rpm.html
- page: Source Installation Guide
url: /ak-install-source.html
- page: Configuration Guide
url: /ak-configuration.html
- page: Database Guide
url: /ak-databases.html
- title: Using
subfolderitems:
- page: Command Reference
url: /ak-commands.html
- page: Ingestor Guide
url: /ak-ingestor.html
- title: Developing
subfolderitems:
- page: Open XDMoD Module
url: https://github.com/ubccr/xdmod-appkernels
- page: AKRR
url: https://github.com/ubccr/akrr
31 changes: 0 additions & 31 deletions docs/_includes/menu.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/ak-install-rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Application Kernels RPM Installation Guide
Install RPM Package
-------------------

# yum install xdmod-appkernels-x.x.x-x.x.el6.noarch.rpm
# yum install xdmod-appkernels-{{ page.sw_version }}-1.0.el7.noarch.rpm

Run Configuration Script
------------------------
Expand Down

0 comments on commit 6dfdde5

Please sign in to comment.