-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcontributing-docs.html
704 lines (385 loc) · 30.2 KB
/
contributing-docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content=" Contributing to Documentation Previous Next 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!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.Setting Up Your Development EnvironmentInstalling DependenciesInitially (on OS X), you will need to setup Brew which is a package manager for OS X and Git. To install Brew and Git, run the following commands:/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"brew install gitFork the repoTo contribute to the web based documentation, you should obtain a GitHub account and fork the Singularity GitHub Pages 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:git clone https://github.com/user99/singularityware.github.io.gitcd singularityware.github.io/Install a local Jekyll serverThis 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.brew install rubygem install jekyllgem install bundlerbundle installNow you can see the site locally by running the server with jekyll:bundle exec jekyll serveThis will make the site viewable at http://localhost:4005/.Contributing a News ItemEach news item that is rendered automatically in the site feed and the news page is done very simply - you just add a new markdown file to the folder _posts/news. There are a few rules you must follow:Naming ConventionThe name of the markdown file must be in the format YYYY-MM-DD-meaningful-name.md For example, 2016-09-23-first-post.mdFront End MatterJekyll has this thing they call front matter which is basically a header in your markdown file. For our news feed, the header should look something like this: --- title: "Welcome to Singularity" category: news permalink: first-post ---and then write your post after it in Markdown Syntax. All and any HTML tags are fair game as well! Once you add the post, if you have set the category correctly to “news” it should show up in the site feed. It’s that easy!Contributing to a PageAll of the pages are in the pages folder, organized in a somewhat logical manner. If you want to edit content for a page, just edit the corresponding file. If you need to do something more advanced like edit a sidebar, you should look at the sidebar data yml documents, which render into the navigation.Recording demosIf you think something could be better explained with a demo, record and embed one! Here’s how:Show Video Tutorial # To Installpip install asciinema# To recordasciinema rec -w 1 demo-asciicast.js# type exit when done# To playasciinema play demo-asciicast.jsOnce you’ve generated an asciicast, you should drop the file (e.g., some demo-asciicast.js) into the assets/asciicast folder, and then include the following in the page or post:{% include asciicast.html source='demo-asciicast.js' title='How to make demos' author='[email protected]'%}Adding a ReleaseThe releases, akin to the news, are done via a feed. The only difference is that they are rendered on the site in the releases section. It is also done very simply - you just add a new markdown file to the folder _posts/releases. The same naming convention follows, however the title of the post should correspond to the release, e.g.:Naming ConventionThe name of the markdown file must be in the format YYYY-MM-DD-release-x-x-x.md For example, 2016-09-23-release-2-2-1.mdFront End MatterThe header in your markdown file should look something like this: --- title: "Singularity 2.1.2 release" category: releases permalink: release-2-1-2 targz: "2.1.2.tar.gz" --- The targz is the name of the file in the “archive” section of the repository defined in the _config.yml file’s “repo” variable. This link will be rendered automatically on the site. The category is also very important, and must be “releases” otherwise it won’t show up.In the markdown file above, after the front end matter you can again use Markdown and HTML to write about the release, make lists of features, and go to town. Previous Next Edit me Site last generated: Jul 26, 2017 ">
<meta name="name" content="Contributing to Documentation">
<meta name="thumbnail" content="http://singularity.lbl.gov/images/logo/logo.svg">
<title>Contributing to Documentation | Singularity</title>
<link rel="stylesheet" href="assets/css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="assets/css/modern-business.css">
<link rel="stylesheet" href="assets/css/lavish-bootstrap.css">
<link rel="stylesheet" href="assets/css/customstyles.css">
<link rel="stylesheet" href="assets/css/theme-blue.css">
<link rel="stylesheet" type="text/css" href="assets/css/asciinema-player.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="assets/js/jquery.navgoco.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="assets/js/toc.js"></script>
<script src="assets/js/customscripts.js"></script>
<link rel="shortcut icon" href="images/favicon/favicon.ico">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="" href="http://localhost:4005feed.xml">
<script>
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
</script>
<script>
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
</script>
</head>
<body>
<!-- asciinema player -->
<script src="assets/js/asciinema-player.js"></script>
<!-- Show or hide players on button clicks-->
<script>
$( document ).ready(function() {
$(".asciinema-button").click(function(){
var asciinemaVideo = "#asciinema-" + $(this).attr('id');
if ($(asciinemaVideo).hasClass('hidden')){
$(asciinemaVideo).removeClass('hidden');
$(this).text('Hide Tutorial')
} else {
$(asciinemaVideo).addClass('hidden');
$(this).text('Show Tutorial')
}
});
});
</script>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top">
<div class="container topnavlinks">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"> <span class="projectTitle"> Singularity</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<!-- entries without drop-downs appear here -->
<li><a href="blog">News</a></li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Docs<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="admin-guide">Admin Guide</a></li>
<li><a href="user-guide">User Guide</a></li>
<li><a href="links">Contributed Content</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Quick Links<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://github.com/singularityware/singularity" target="_blank">Github Repo</a></li>
<li><a href="https://groups.google.com/a/lbl.gov/forum/#!forum/singularity" target="_blank">Google Group</a></li>
<li><a href="http://stackoverflow.com/questions/tagged/singularity" target="_blank">Singularity on Stack Overflow</a></li>
<li><a href="https://singularity-hub.org/faq" target="_blank">Singularity Hub</a></li>
<li><a href="https://singularity-container.slack.com" target="_blank">Slack</a></li>
<li><a href="faq#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">People<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.lbl.gov/" target="_blank">LBNL</a></li>
<li><a href="https://srcc.stanford.edu/" target="_blank">Stanford</a></li>
</ul>
</li>
<li><a href="/search"><i class="fa fa-search"></i></li>
<!-- jekyll search hidden in favor of google
<li>
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="search...">
<ul id="results-container"></ul>
</div>
<script src="assets/js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '<li><a href="{url}" title="Contributing to Documentation">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
</script>
end search-->
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<div class="container">
<div class="col-lg-12"> </div>
<!-- Content Row -->
<div class="row">
<!-- Sidebar Column -->
<div class="col-md-3">
<div class="shiny"><a href="\"><figure><img src="/images/logo/logo.svg" class="sidebar-logo"/></figure></a></div>
<ul id="mysidebar" class="nav">
<li class="sidebarTitle">Singularity</li>
<li>
<a href="#">Information</a>
<ul>
<li><a href="blog">News</a></li>
<li><a href="about">About Singularity</a></li>
<li><a href="presentations">Presentations</a></li>
<li><a href="citation-registration">Registry: Citations and Installations</a></li>
</ul>
<li>
<a href="#">Download / Installation</a>
<ul>
<li><a href="all-releases">All Releases</a></li>
<li><a href="install-linux">Install Singularity on Linux</a></li>
<li><a href="install-mac">Install Singularity on Mac</a></li>
<li><a href="install-windows">Install Singularity on Windows</a></li>
</ul>
<li>
<a href="#">Contributing</a>
<ul>
<li><a href="contributing-support">User Support</a></li>
<li><a href="contributing-code">Code Development</a></li>
<li class="active"><a href="contributing-docs">Writing Documentation</a></li>
</ul>
<li>
<a href="#">Getting Help</a>
<ul>
<li><a href="faq">FAQ</a></li>
<li><a href="support">Support</a></li>
<li><a href="faq#troubleshooting">Troubleshooting</a></li>
</ul>
<li>
<a href="#">Documentation</a>
<ul>
<li><a href="quickstart">Quick Start</a></li>
<li><a href="tutorials">Recipes and Tutorials</a></li>
<li><a href="links">Contributed Content Links</a></li>
<li><a href="user-guide">User Documentation</a></li>
<li><a href="admin-guide">Admin Documentation</a></li>
</ul>
<!-- if you aren't using the accordion, uncomment this block:
<p class="external">
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
</p>
-->
</li>
</ul>
</div>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
<!-- Content Column -->
<div class="col-md-9">
<div class="post-header">
<h1 class="post-title-main">Contributing to Documentation</h1>
</div>
<div class="post-content">
<!-- Previous and next buttons-->
<div class="row" style="padding-top:30px; margin-bottom:10px"><div class="col-md-12">
<a href="#"><button style="width:20%; height: 70px; float:left" class="hidden previous-button btn btn-lg btn-default">Previous</button></a>
<a href="#"><button style="width:20%; height: 70px; float:right" class="hidden next-button btn btn-lg btn-default">Next</button></a>
</div></div>
<script>
$(document).ready(function(){
var next = $("li.active").next().last().find('a').attr('href');
var previous = $("li.active").prev().last().find('a').attr('href');
// NEXT BUTTON
if (typeof next == 'undefined'){
console.log("disabling next button")
$(".next-button").addClass("hidden")
} else if (next == "#") {
next = $("li.active").next().find("li").first().find('a').attr('href');
$(".next-button").closest('a').attr('href', next)
$(".next-button").removeClass('hidden')
} else {
$(".next-button").closest('a').attr('href', next)
$(".next-button").removeClass('hidden')
}
// PREVIOUS BUTTON
if (typeof previous == 'undefined'){
console.log("disabling previous button")
$(".previous-button").addClass("hidden")
} else if (previous == "#") {
previous = $("li.active").prev().find("li").last().find('a').attr('href')
$(".previous-button").closest('a').attr('href', previous)
$(".previous-button").removeClass('hidden')
} else {
$(".previous-button").closest('a').attr('href', previous)
$(".previous-button").removeClass('hidden')
}
})
</script>
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
// Handler for .ready() called.
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
var target = $(this.getAttribute('href'))
, scroll_target = target.offset().top
$(window).scrollTop(scroll_target - 10);
return false
})
});
</script>
<div id="toc"></div>
<p>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!</p>
<p>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.</p>
<h2 id="setting-up-your-development-environment">Setting Up Your Development Environment</h2>
<h3 id="installing-dependencies">Installing Dependencies</h3>
<p>Initially (on OS X), you will need to setup <a href="http://brew.sh/">Brew</a> which is a package manager for OS X and <a href="https://git-scm.com/">Git</a>. To install Brew and Git, run the following commands:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>/usr/bin/ruby -e <span class="s2">"</span><span class="k">$(</span>curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install<span class="k">)</span><span class="s2">"</span>
brew install git
</code></pre>
</div>
<h3 id="fork-the-repo">Fork the repo</h3>
<p>To contribute to the web based documentation, you should obtain a GitHub account and <em>fork</em> the <a href="https://github.com/singularityware/singularityware.github.io/" target="_blank">Singularity GitHub Pages</a> repository by clicking the <em>fork</em> 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 <em>user99</em>:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>git clone https://github.com/user99/singularityware.github.io.git
<span class="nb">cd </span>singularityware.github.io/
</code></pre>
</div>
<h3 id="install-a-local-jekyll-server">Install a local Jekyll server</h3>
<p>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.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>brew install ruby
gem install jekyll
gem install bundler
bundle install
</code></pre>
</div>
<p>Now you can see the site locally by running the server with jekyll:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>bundle <span class="nb">exec </span>jekyll serve
</code></pre>
</div>
<p>This will make the site viewable at <a href="http://localhost:4005/" target="_blank">http://localhost:4005/</a>.</p>
<h2 id="contributing-a-news-item">Contributing a News Item</h2>
<p>Each news item that is rendered automatically in the <a href="http://localhost:4005/feed.xml" target="_blank">site feed</a> and the <a href="/blog" target="_blank">news page</a> is done very simply - you just add a new markdown file to the folder <code class="highlighter-rouge">_posts/news</code>. There are a few rules you must follow:</p>
<h3 id="naming-convention">Naming Convention</h3>
<p>The name of the markdown file must be in the format <code class="highlighter-rouge">YYYY-MM-DD-meaningful-name.md</code> For example, <code class="highlighter-rouge">2016-09-23-first-post.md</code></p>
<h3 id="front-end-matter">Front End Matter</h3>
<p>Jekyll has this thing they call <a href="https://jekyllrb.com/docs/frontmatter/" target="_blank">front matter</a> which is basically a header in your markdown file. For our news feed, the header should look something like this:</p>
<div class="highlighter-rouge"><pre class="highlight"><code> ---
title: "Welcome to Singularity"
category: news
permalink: first-post
---
</code></pre>
</div>
<p>and then write your post after it in <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet" target="_blank">Markdown Syntax</a>. All and any HTML tags are fair game as well! Once you add the post, if you have set the category correctly to “news” it should show up in the site feed. It’s that easy!</p>
<h2 id="contributing-to-a-page">Contributing to a Page</h2>
<p>All of the pages are in the <a href="https://github.com/singularityware/singularityware.github.io/blob/master/pages" target="_blank">pages</a> folder, organized in a somewhat logical manner. If you want to edit content for a page, just edit the corresponding file. If you need to do something more advanced like edit a sidebar, you should look at the <a href="https://github.com/singularityware/singularityware.github.io/blob/master/_data/sidebars" target="_blank">sidebar data</a> yml documents, which render into the navigation.</p>
<h3 id="recording-demos">Recording demos</h3>
<p>If you think something could be better explained with a demo, record and embed one! Here’s how:</p>
<p><button style="color:white;margin-top:5px" class="btn btn-primary btn-lg asciinema-button" id="How-to-make-demos">Show Video Tutorial</button></p>
<div class="hidden" id="asciinema-How-to-make-demos">
<asciinema-player src="assets/asciicast/demo-asciicast.js" poster="data:text/plain,How to make demos" title="How to make demos" author="[email protected]" cols="115" rows="25" speed="2.0" theme="asciinema">
</asciinema-player>
</div>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c"># To Install</span>
pip install asciinema
<span class="c"># To record</span>
asciinema rec -w 1 demo-asciicast.js
<span class="c"># type exit when done</span>
<span class="c"># To play</span>
asciinema play demo-asciicast.js
</code></pre>
</div>
<p>Once you’ve generated an asciicast, you should drop the file (e.g., some <code class="highlighter-rouge">demo-asciicast.js</code>) into the <code class="highlighter-rouge">assets/asciicast</code> folder, and then include the following in the page or post:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">{% </span>include asciicast.html <span class="nb">source</span><span class="o">=</span><span class="s1">'demo-asciicast.js'</span> <span class="nv">title</span><span class="o">=</span><span class="s1">'How to make demos'</span> <span class="nv">author</span><span class="o">=</span><span class="s1">'[email protected]'</span>%<span class="o">}</span>
</code></pre>
</div>
<h2 id="adding-a-release">Adding a Release</h2>
<p>The releases, akin to the news, are done via a feed. The only difference is that they are rendered on the site in the <a href="/releases" target="_blank">releases section</a>. It is also done very simply - you just add a new markdown file to the folder <code class="highlighter-rouge">_posts/releases</code>. The same naming convention follows, however the title of the post should correspond to the release, e.g.:</p>
<h3 id="naming-convention-1">Naming Convention</h3>
<p>The name of the markdown file must be in the format <code class="highlighter-rouge">YYYY-MM-DD-release-x-x-x.md</code> For example, <code class="highlighter-rouge">2016-09-23-release-2-2-1.md</code></p>
<h3 id="front-end-matter-1">Front End Matter</h3>
<p>The header in your markdown file should look something like this:</p>
<div class="highlighter-rouge"><pre class="highlight"><code> ---
title: "Singularity 2.1.2 release"
category: releases
permalink: release-2-1-2
targz: "2.1.2.tar.gz"
---
</code></pre>
</div>
<p>The targz is the name of the file in the “archive” section of the repository defined in the _config.yml file’s “repo” variable. This link will be rendered automatically on the site. The category is also very important, and must be “releases” otherwise it won’t show up.</p>
<p>In the markdown file above, after the front end matter you can again use Markdown and HTML to write about the release, make lists of features, and go to town.</p>
<!-- More navigation on the bottom -->
<div class="row" style="padding-top:30px; margin-bottom:10px"><div class="col-md-12">
<a href="#"><button style="width:20%; height: 70px; float:left" class="hidden previous-button btn btn-lg btn-default">Previous</button></a>
<a href="#"><button style="width:20%; height: 70px; float:right" class="hidden next-button btn btn-lg btn-default">Next</button></a>
</div></div>
<a style="margin-top:10px;margin-bottom:10px" target="_blank" href="https://github.com/singularityware/singularityware.github.io/blob/master/pages/_pages/releases/contributing-docs.md" class="btn btn-default btn-xs githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
<div class="tags">
</div>
</div>
<hr class="shaded"/>
<footer>
<div class="row">
<!-- Social Media links, etc -->
<div class="col-lg-6 footer">
<a class="no-after social-icon" href="https://twitter.com/SingularityApp">
<i class="fa fa-4x fa-twitter no-after"></i>
</a>
<a class="no-after social-icon" href="https://github.com/singularityware">
<i class="fa fa-4x fa-github no-after"></i>
</a>
</div>
<div class="col-lg-6 footer">
<p><img src="images/logo/logo.png" alt="Company logo" style="width:40px;padding-bottom:10px"/></p>
Site last generated: Jul 26, 2017 <br />
</div>
</div>
</footer>
</div>
<!-- /.row -->
</div>
<!-- /.container -->
</div>
</body>
<!-- the google_analytics_id gets auto inserted from the config file -->
<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create','UA-84672381-1','auto');ga('require','displayfeatures');ga('send','pageview');</script>
</html>