forked from virtix/open-source-program-template
-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathindex.html
235 lines (150 loc) · 11.2 KB
/
index.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>United States Open Source Program</title>
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="/assets/css/normalize.css">
<link rel="stylesheet" href="/assets/css/main.css">
<link rel="stylesheet" href="/assets/css/syntax.css">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<script src="/assets/js/respond.min.js"></script>
<![endif]-->
</head>
<body>
<header role="banner">
<!-- Fork Me at GitHub banner. Remove, of course -->
<a href="https://github.com/virtix/open-source-program-template"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub"></a>
<div class="wrap">
<h1><a class="title-link" href="/">A Government Open Source Program</a></h1>
<div style="float:right">
<!-- This should be a configurable item in data/ -->
<a href="/index.html" class="title-link">
<img height="52" src="/assets/img/USA_flag_icon.png" alt="Your agency logo">
</a>
</div>
</div>
</header>
<div class="wrap content">
<aside>
<p class="intro">A set of templates and artifacts to support open source programs</p>
<a class="skip-link visuallyhidden focusable" href="#main">Skip to Main Content</a>
<nav role="navigation">
<ul>
<li><a href="/index.html">Home</a></li>
<li><a href="/pages/guiding_principles.html">Guiding Principles</a></li>
<li><a href="/pages/oss_policy.html">Open Source Policy</a></li>
<li><a href="/pages/news.html">News</a></li>
<li><a href="/pages/open_by_default.html">Open By Default</a></li>
<li><a href="/pages/faq.html">FAQs</a></li>
<li><a href="/pages/workflows.html">Processes & Procedures</a></li>
<li><a href="/pages/references.html">References</a></li>
<li><a href="/pages/howto.html">How to configure this site</a></li>
<!-- Prose.io edit link -->
<li><a href="http://prose.io#virtix/open-source-program-template/edit/gh-pages/index.md" target="_blank">Edit this page on prose.io</a>
</li>
</ul>
</nav>
</aside>
<section id="main" class="main-content" role="main">
<h2 id="your-organization-name">YOUR ORGANIZATION NAME</h2>
<h2 id="how-to-configure-and-edit-this-page-and-site">How to configure and edit this page and site</h2>
<p>This site is built with <a href="http://jekyllrb.com/">Jekyll</a>, so you should
have that installed and be familiar with it.</p>
<h4 id="quick-start">Quick Start</h4>
<ol>
<li>Fork this repo/site by clicking the <a href="https://github.com/virtix/open-source-program-template">“Fork me on GitHub”</a>
ribbon in the upper right-hand corner.</li>
<li>Make sure the default branch is set to <code>gh-pages</code>. This can be found in your <a href="https://github.com/YOUR_USERNAME/open-source-program-template/settings">project’s settings</a></li>
<li>Navigate to <a href="http://YOUR_USERNAME.github.io">http://YOUR_USERNAME.github.io</a>
You should see the un-edited micro-site.</li>
<li>Navigate to <a href="http://prose.io">prose.io</a> and log in with your GitHub account</li>
<li>Find the <code>opensource-program-template</code> and use prose.io to edit files and create content.</li>
</ol>
<h4 id="editing-this-page">Editing this page</h4>
<p>Edit the <code>index.md</code> file in your project root to add welcome content and
any other data you want. </p>
<p><strong>Note</strong>: Make sure to change the <code>title: ...</code>.</p>
<h4 id="removing-the-fork-me-on-github-ribbon">Removing the “Fork me on GitHub” ribbon</h4>
<p>Edit the <code>_layouts\default.html</code> file. The ribbon code is on
about line #23. Just replace it or delete it.</p>
<h4 id="changing-information-about-your-organization">Changing information about your organization</h4>
<p>Navigate to the file <code>data/meta.yml</code>. This is a data file and contains
basic information about your organization—name, address, point of contact, etc.</p>
<div class="highlight"><pre><code class="yaml"><span class="l-Scalar-Plain">org_name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">YOUR ORGANIZATION NAME</span>
<span class="l-Scalar-Plain">org_abbrev</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Y.O.N.</span>
<span class="l-Scalar-Plain">address</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">street</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">1000 Main Street</span>
<span class="l-Scalar-Plain">suite</span><span class="p-Indicator">:</span>
<span class="l-Scalar-Plain">city</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Washington</span>
<span class="l-Scalar-Plain">state</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">D.C.</span>
<span class="l-Scalar-Plain">zip</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">20000</span>
<span class="l-Scalar-Plain">point_of_contact</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">Thomas Jefferson</span>
<span class="nn">...</span>
</code></pre></div>
<h4 id="changing-the-sites-main-title-default-a-government-open-source-program">Changing the site’s main title (default: A Government Open Source Program)</h4>
<p>Navigate to the file <code>_config.yml</code> in your project’s root directory. Change the
<code>name:</code> element on line 18 or so to your desired site’s name.</p>
<div class="highlight"><pre><code class="yaml"><span class="c1"># Your Programs's Name</span>
<span class="l-Scalar-Plain">name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">A Government Open Source Program</span>
<span class="l-Scalar-Plain">subtitle</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">A set of templates and artifacts to support open source programs</span>
</code></pre></div>
<h4 id="changing-the-sites-logo">Changing the site’s logo</h4>
<p>Navigate to the file <code>data/meta.yml</code> and change the <code>logo_url</code> to a valid
location to your logo. This can either be an HTTP URL or a new local image file.</p>
<div class="highlight"><pre><code class="yaml"><span class="l-Scalar-Plain">logo_url</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">/assets/img/USA_flag_icon.png</span>
</code></pre></div>
<h4 id="editing-content">Editing content</h4>
<p>There are two types of content: pages and posts (or news items). Posts are discussed next.</p>
<p>To edit existing pages, navigate to the <code>pages</code> directory in your project’s root. Edit
the files in your editor of choice. These are written in <a href="https://daringfireball.net/projects/markdown/">markdown</a>.</p>
<p>If your site is hosted at GitHub using <a href="http://pages.github.com/">GitHub Pages</a> you can edit the content
directly or you can use <a href="http://prose.io/">Prose.io</a>.</p>
<h4 id="creating-news-items">Creating News Items</h4>
<p>To create a <em>new</em> post, copy the <code>_posts/post-template.md</code> file to the same directory and use this
file naming convention: <code>YYYY-MM-DD-Your-Post-Title.md</code>. Edit that file accordingly and it
will automatically be displayed on the the <a href="news.html">news page</a>. </p>
<h4 id="adding-new-pages">Adding new pages</h4>
<p>Copy the <code>pages/page_template.md</code> file to <code>pages/your_file_name.md</code> and add content as desired.</p>
<h4 id="addingchanging-left-hand-navigation">Adding/Changing Left-hand Navigation</h4>
<p>In your project’s root directory, open <code>_config.yml</code>. Towards the bottom there is a
<code>navigation:</code> node. Each child in the node represents a new navigation item. Each item
has text,url, and internal properties. The <code>text</code> property is the text that is displayed
on the page. The <code>url</code> property is the target destination. </p>
<h4 id="working-with-github-pages">Working with GitHub pages</h4>
<p>Using Jekyll and GitHub pages allows you to easily manage and publish content. See
<a href="https://help.github.com/articles/using-jekyll-with-pages">GitHub</a> for more information.</p>
<h4 id="working-with-proseiohttpsgithubcomproseprosewikigetting-started">Working with <a href="https://github.com/prose/prose/wiki/Getting-Started">prose.io</a></h4>
<p>Prose.io is an open source tool for managing content on GitHub.
Use it to create, edit, or delete files in your project. Prose.io is <em>Jekyll-aware</em>
so, it adds a few features if you are using Jekyll. These included the ability to
save <em>drafts</em>, and <em>publish</em> or <em>unpublish</em> posts.</p>
<p>If you publish this using GitHub Pages, you can easily allow contributions. Notice the
the <a href="http://prose.io#virtix/open-source-program-template/edit/gh-pages/index.md" target="_blank">Edit this page on prose.io</a>
link in the left hand navigation. You can customize this
by editing the <code>_config.yml</code> file. Update the <code># Prose.io editing</code> section with
your GitHub information:</p>
<div class="highlight"><pre><code class="yaml"><span class="c1">#Prose.io editing info</span>
<span class="l-Scalar-Plain">repo_name</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">open-source-program-template</span>
<span class="l-Scalar-Plain">branch</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">gh-pages</span>
<span class="c1">#GitHub organization name *or* username</span>
<span class="l-Scalar-Plain">gh_org</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">virtix</span>
<span class="l-Scalar-Plain">prose_url</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://prose.io</span>
<span class="l-Scalar-Plain">site_url</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">http://if.io/open-source-program-template</span>
<span class="l-Scalar-Plain">media</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">assets/img</span>
</code></pre></div>
<p>To remove the edit on prose.io link, remove the following lines from the
<code>_includes/sidebar.html</code> file:</p>
<div class="highlight"><pre><code class="html"><span class="c"><!-- Prose.io edit link --></span>
<span class="nt"><li></span>{% include prose_edit_url.html %}<span class="nt"></li></span>
</code></pre></div>
</section>
<footer role="contentinfo">
<p>This project is maintained by <a href="mailto:[email protected]">Thomas Jefferson</a></p>
<p>Hosted on Github Pages</p>
</footer>
</div><!-- /.wrap -->
</body>
</html>