[examples/openspending] - openspending v0.2 (#907)
* [examples/openspending] - openspending v0.2 * [examples/openspending][m] - fix build * [examples/openspending][xs] - fix build * [examples/openspending][xs] - add prebuild step * [examples/openspending][m] - fix requested by demenech * [examples/openspending][sm] - remove links + fix bug
This commit is contained in:
Luccas Mateus
GitHub
126
examples/openspending/content/about/meta/contribute/adding.html
Normal file
126
examples/openspending/content/about/meta/contribute/adding.html
Normal file
@@ -0,0 +1,126 @@
|
||||
---
|
||||
lang: en
|
||||
title: Adding a page
|
||||
authors:
|
||||
- Sam Smith
|
||||
section: meta
|
||||
---
|
||||
|
||||
<p class="lead">Most of what you need to know to add a new page is covered under ‘<a href="{{ "/meta/contribute/editing/" | prepend: site.baseurl }}">Editing a page</a>’, so make sure you have first read through that section.</p>
|
||||
|
||||
<p>Adding a page follows a similar process to editing. Instead of locating your page, your first step is to locate your new page’s parent directory.</p>
|
||||
|
||||
<h2>1: Create the page</h2>
|
||||
|
||||
<p>First locate the parent directory, or folder, in which your file will live. If you are adding a page to the "Get Involved" section, for example, you should be in the '<strong>get-involved</strong>' directory, where you’ll see a list of all the pages related to contributions.</p>
|
||||
|
||||
<p>Above the list of pages is a breadcrumb trail <code>{{ site.github_repo }} / get-involved / </code>, to the right of which is a plus symbol <code><strong>+</strong></code>. Click the plus symbol to create your new page.</p>
|
||||
|
||||
<h2>2: Name your file</h2>
|
||||
|
||||
<p>You should now have a new file editor page open. The first editable section you are presented with is the ‘<em>Name your file</em>’ field. As we touched upon when looking at <a href="{{ "/meta/contribute/editing/" | prepend: site.baseurl }}">editing files</a>, the file name corresponds to the URL of the page on the site. There are a few of rules to follow here:</p>
|
||||
|
||||
<ul>
|
||||
<li>The file name should reflect the title of the new page</li>
|
||||
<li>Must be unique</li>
|
||||
<li>Should be all lowercase</li>
|
||||
<li>Words should be separated by hyphens (-)</li>
|
||||
<li>File name should end with the extension '<em>.md</em>' (the .md extension indicates a markdown file)</li>
|
||||
</ul>
|
||||
|
||||
<p>As an example, if you were creating a page titled '<em>My Cool Page</em>', you would use a file name of:</p>
|
||||
|
||||
<pre>
|
||||
<code>my-cool-page.md</code>
|
||||
</pre>
|
||||
|
||||
<p>Assuming you are creating this in the '<em>get-involved</em>' directory, this would result in a URL of <em>{{ site.url }}/get-involved/my-cool-page</em></p>
|
||||
|
||||
<div class="note">
|
||||
<h6>Note</h6>
|
||||
<p>The actual words used in your file name are not crucial. It’s fine to use a more succinct version of your page title, for example.</p>
|
||||
</div>
|
||||
|
||||
<h2>3: Formatting your content</h2>
|
||||
|
||||
<p>This step is the same as when editing a page. You need to start your file with the Front Matter, then add your content, formatting it using Markdown. Here is a template to get you started:</p>
|
||||
|
||||
<pre>
|
||||
<code>---
|
||||
title: My Cool Page
|
||||
authors:
|
||||
- Fred Bloggs
|
||||
---
|
||||
|
||||
##A large introductory paragraph.
|
||||
|
||||
Regular paragraphs, separated by empty lines.
|
||||
|
||||
###A heading
|
||||
|
||||
Another paragraph.
|
||||
|
||||
* Maybe
|
||||
* a
|
||||
* list</code>
|
||||
</pre>
|
||||
|
||||
<p>When you’re done, click ‘<em>Propose new file</em>’.</p>
|
||||
|
||||
<h2>4: Make a pull request</h2>
|
||||
|
||||
<p>Once you have created your page(s) and updated the contents document, you're ready to make your pull request. Click the pull request icon to the right of the screen <code class="icon-git-pull-request"><span>[git pull-request icon]</span></code>, then click ‘<em>New pull request</em>’.</p>
|
||||
|
||||
<p>At the top of the resulting comparison screen, you’ll see a row of select boxes. You want to make sure these are configured like so:</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="github panel">
|
||||
<div class="range-editor">
|
||||
<span class="icon-git-compare range-editor-icon"></span>
|
||||
<div class="range">
|
||||
|
||||
<div class="range-cross-repo-pair">
|
||||
<div class="select-menu js-menu-container js-select-menu fork-suggester">
|
||||
<span class="minibutton select-menu-button js-menu-target" role="button" aria-label="Choose a Base Repository" aria-haspopup="true">
|
||||
<i>base fork:</i>
|
||||
<span class="js-select-button css-truncate css-truncate-target" title="base: ckan/ckan">{{ site.github_username }}/{{ site.github_repo }}</span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="select-menu js-menu-container js-select-menu commitish-suggester">
|
||||
<span class="minibutton select-menu-button js-menu-target branch" role="button" aria-label="Choose a base branch" aria-haspopup="true">
|
||||
<i>base:</i>
|
||||
<span class="js-select-button css-truncate css-truncate-target" title="base: master">gh-pages</span>
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<span class="dots">...</span>
|
||||
|
||||
<div class="range-cross-repo-pair">
|
||||
<div class="select-menu js-menu-container js-select-menu fork-suggester">
|
||||
<span class="minibutton select-menu-button js-menu-target" role="button" aria-label="Choose a Head Repository" aria-haspopup="true">
|
||||
<i>head fork:</i>
|
||||
<span class="js-select-button css-truncate css-truncate-target" title="head: mintcanary/ckan"><em>username</em>/{{ site.github_repo }}</span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div class="select-menu js-menu-container js-select-menu commitish-suggester">
|
||||
<span class="minibutton select-menu-button js-menu-target branch" role="button" aria-label="Choose a head branch" aria-haspopup="true">
|
||||
<i>compare:</i>
|
||||
<span class="js-select-button css-truncate css-truncate-target" title="compare: master"><em>branch</em></span>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<article class="post-content">
|
||||
<p><em><strong>username</strong> being your github username, <strong>branch</strong> being the branch you have been working on.</em></p>
|
||||
|
||||
<p>You should now be able to see listed below, all the changes that you wish to contribute. If everything looks as it should, click ‘<em>Create pull request</em>’.</p>
|
||||
|
||||
<p>Give your pull request a title and description, then click ‘<em>Create pul request</em>’. You have now contributed your pages to the OpenSpending Community site :)</p>
|
||||
Reference in New Issue
Block a user