Skip to content

Commit 905e2e8

Browse files
vsochvsoch
committed
Merge branch 're-org' of github.com:gmkurtzer/singularityware.github.io into re-org
2 parents 5737637 + 0b841b4 commit 905e2e8

39 files changed

+228
-70
lines changed

‎404.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Page Not Found"
33
search: exclude
4+
sidebar: main_sidebar
45
---
56

67
Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

‎_config.yml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ defaults:
6666
layout: "page"
6767
comments: true
6868
search: true
69-
sidebar: docs_sidebar
69+
sidebar: main_sidebar
7070
-
7171
scope:
7272
path: ""
@@ -85,11 +85,10 @@ defaults:
8585
layout: "post"
8686
comments: true
8787
search: true
88-
sidebar: docs_sidebar
88+
sidebar: main_sidebar
8989

9090

9191
# these are defaults used for the frontmatter for these file types
9292

9393
sidebars:
94-
- home_sidebar
95-
- docs_sidebar
94+
- main_sidebar

‎_data/sidebars/main_sidebar.yml‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
2+
3+
entries:
4+
5+
- title: Singularity
6+
folders:
7+
8+
9+
- title: Information
10+
output: web, pdf
11+
folderitems:
12+
13+
- title: News
14+
url: /blog
15+
output: web, pdf
16+
17+
- title: About Singularity
18+
url: /about
19+
output: web, pdf
20+
21+
- title: Presentations
22+
url: /presentations
23+
output: web, pdf
24+
25+
- title: Singularity Registry
26+
url: /registry
27+
output: web, pdf
28+
29+
- title: Follow Singularty @
30+
url: /follow
31+
output: web, pdf
32+
33+
34+
- title: Download / Installation
35+
output: web, pdf
36+
folderitems:
37+
38+
- title: All Releases
39+
url: /all-releases
40+
output: web, pdf
41+
42+
- title: Install Singularity on Linux
43+
url: /install-linux
44+
output: web, pdf
45+
46+
- title: Install Singularity on Mac
47+
url: /install-mac
48+
output: web, pdf
49+
50+
- title: Install Singularity on Windows
51+
url: /install-windows
52+
output: web, pdf
53+
54+
55+
- title: Documentation
56+
output: web, pdf
57+
folderitems:
58+
59+
- title: Quick Start
60+
url: /quickstart # was /start
61+
output: web, pdf
62+
63+
- title: Recipes and Tutorials
64+
url: /recipes
65+
output: web, pdf
66+
67+
- title: User Documentation
68+
url: /user_guide
69+
output: web, pdf
70+
71+
- title: Admin Documentation
72+
url: /admin_guide
73+
output: web, pdf
74+
75+
76+
- title: Contributing
77+
output: web, pdf
78+
folderitems:
79+
80+
- title: User Support
81+
url: /contributing-support
82+
output: web, pdf
83+
84+
- title: Code Development
85+
url: /contributing-code
86+
output: web, pdf
87+
88+
- title: Documentation
89+
url: /contributing-docs
90+
output: web, pdf
91+
92+
93+
- title: Getting Help
94+
output: web, pdf
95+
folderitems:
96+
97+
- title: FAQ
98+
url: /faq
99+
output: web, pdf
100+
101+
- title: Troubleshooting
102+
url: /troubleshooting
103+
output: web, pdf
104+
105+
- title: Community Support
106+
url: /community-support
107+
output: web, pdf
108+
109+
- title: Professional Support
110+
url: /professional-support
111+
output: web, pdf
112+
113+

‎_includes/custom/sidebarconfigs.html‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
{% if page.sidebar == "docs_sidebar" %}
2-
{% assign sidebar = site.data.sidebars.docs_sidebar.entries %}
3-
{% assign sidebar_pdf = site.data.sidebars.docs_sidebar.entries %}
4-
{% else if page.sidebar == "home_sidebar" %}
5-
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
6-
{% assign sidebar_pdf = site.data.sidebars.home_sidebar.entries %}
1+
{% if page.sidebar == "main_sidebar" %}
2+
{% assign sidebar = site.data.sidebars.main_sidebar.entries %}
3+
{% assign sidebar_pdf = site.data.sidebars.main_sidebar.entries %}
74
{% else %}
8-
{% assign sidebar = site.data.sidebars.home_sidebar.entries %}
9-
{% assign sidebar_pdf = site.data.sidebars.home_sidebar.entries %}
5+
{% assign sidebar = site.data.sidebars.main_sidebar.entries %}
6+
{% assign sidebar_pdf = site.data.sidebars.main_sidebar.entries %}
107
{% endif %}

‎_layouts/page.html‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,30 +43,23 @@ <h1 class="post-title-main">{{ page.title }}</h1>
4343
<script>
4444
$(document).ready(function(){
4545

46-
var next = $("li.active").next().last().find('a').attr('href');
47-
var previous = $("li.active").prev().last().find('a').attr('href');
46+
var next = "{{ page.next }}";
47+
var previous = "{{ page.previous }}";
4848

4949
// NEXT BUTTON
50-
if (typeof next == 'undefined'){
50+
if (next == ''){
5151
console.log("disabling next button")
5252
$(".next-button").addClass("hidden")
53-
} else if (next == "#") {
54-
next = $("li.active").next().find("li").first().find('a').attr('href');
55-
$(".next-button").closest('a').attr('href', next)
56-
$(".next-button").removeClass('hidden')
5753
} else {
5854
$(".next-button").closest('a').attr('href', next)
55+
//$(".next-button").attr('href', next);
5956
$(".next-button").removeClass('hidden')
6057
}
6158

6259
// PREVIOUS BUTTON
63-
if (typeof previous == 'undefined'){
60+
if (previous == ''){
6461
console.log("disabling previous button")
6562
$(".previous-button").addClass("hidden")
66-
} else if (previous == "#") {
67-
previous = $("li.active").prev().find("li").last().find('a').attr('href')
68-
$(".previous-button").closest('a').attr('href', previous)
69-
$(".previous-button").removeClass('hidden')
7063
} else {
7164
$(".previous-button").closest('a').attr('href', previous)
7265
$(".previous-button").removeClass('hidden')

‎index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Singularity
33
keywords: containers,
4-
sidebar: docs_sidebar
4+
sidebar: main_sidebar
55
permalink: index.html
66
toc: false
77
---
@@ -17,7 +17,7 @@ Singularity also allows you to leverage the resources of whatever host you are o
1717

1818
## Getting started
1919

20-
Jump in and <a href="/start"><strong>get started</strong></a>.
20+
Jump in and <a href="/quickstart"><strong>get started</strong></a>.
2121

2222
<hr style="margin-top:20px">
2323

‎pages/docs/contributing/contributing-docs.md‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,35 @@
11
---
22
title: Contributing to Documentation
3-
sidebar: docs_sidebar
3+
sidebar: main_sidebar
44
permalink: contributing-docs
55
folder: releases
66
---
77

88
We (like almost all open source software providers) have a documentation dillemma... We tend to focus on the code features and functionality before working on documentation. And there is very good reason for this, we want to share the love so nobody feels left out!
99

10+
The following documentation page assumes one is running on OS X, but if you are not, you should be able to easily transpose the necessary commands to your operating system of choice.
1011

11-
## Setting up Development
12+
13+
## Setting Up Your Development Environment
14+
15+
### Installing Dependencies
16+
Initially (on OS X), you will need to setup [Brew](http://brew.sh/) which is a package manager for OS X and [Git](https://git-scm.com/). To install Brew and Git, run the following commands:
17+
18+
```bash
19+
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
20+
brew install git
21+
```
1222

1323
### Fork the repo
14-
To contribute to the web based documentation, you should obtain a GitHub account and fork the <a href="https://www.github.com/singularityware/singularityware.github.io" target="_blank">Singularityware site</a> repository. Once forked, you will want to clone the fork of the repo to your computer. Let's say my Github username is vsoch, and I am using ssh:
24+
To contribute to the web based documentation, you should obtain a GitHub account and *fork* the <a href="https://www.github.com/singularityware/singularityware.github.io" target="_blank">Singularity GitHub Pages</a> repository by clicking the *fork* button on the top right of the page. Once forked, you will want to clone the fork of the repo to your computer. Let's say my Github username is *user99*:
1525

1626
```bash
17-
git clone git@github.com:vsoch/singularityware.github.io.git
27+
git clone https://github.com/user99/singularityware.github.io.git
1828
cd singularityware.github.io/
1929
```
2030

2131
### Install a local Jekyll server
22-
This step is required if you want to render your work locally before committing your changes. For the purpose of simplicity, we will articulate how to install Jekyll and its dependencies on a Mac.
32+
This step is required if you want to render your work locally before committing the changes. This is highly recommended to ensure that your changes will render properly and will be accepted.
2333

2434
```bash
2535
brew install ruby
@@ -34,8 +44,7 @@ Now you can see the site locally by running the server with jekyll:
3444
bundle exec jekyll serve
3545
```
3646

37-
This will make the site viewable at `http://localhost:4005/` If you want a nice look into how this works, you will probably want to look into the <a href="" target="_blank">config</a> file, or post a question to one of the <a href="/support" target="_blank">support places</a>.
38-
47+
This will make the site viewable at <a href="http://localhost:4005/" target="_blank">http://localhost:4005/</a>.
3948

4049
## Contributing a News Item
4150

‎pages/docs/contributing/contributing-singularity.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Contributing to Singularity
3-
sidebar: docs_sidebar
3+
sidebar: main_sidebar
44
permalink: contributing-singularity
55
folder: docs
66
---

‎pages/docs/getting-started/bootstrap-image.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Getting Started with Bootstrap
3-
sidebar: docs_sidebar
3+
sidebar: main_sidebar
44
permalink: bootstrap-image
55
folder: docs
66
---

‎pages/docs/getting-started/create-an-image.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Create an Image
3-
sidebar: docs_sidebar
3+
sidebar: main_sidebar
44
permalink: create-image
55
folder: docs
66
---

0 commit comments

Comments
 (0)