Skip to content

Commit

Permalink
add edit on github links at bottom
Browse files Browse the repository at this point in the history
  • Loading branch information
tongueroo committed Jun 7, 2017
1 parent 0e4eb5e commit 81c54c1
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 2 deletions.
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to Lono

Contributing is welcomed and encouraged. We love pull requests!

Here are some ways *you* can contribute:

* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specs
* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
* by refactoring code
* by closing [issues][]
* by reviewing patches

[issues]: https://github.com/tongueroo/lono/issues

## Submitting an Issue

* We use the [GitHub issue tracker][issues] to track bugs and features.
* Before submitting a bug report or feature request, check to make sure it hasn't
already been submitted.
* When submitting a bug report, please include a [Gist][] that includes a stack
trace and any details that may be necessary to reproduce the bug, including
your gem version, Ruby version, and operating system. Ideally, a bug report
should include a pull request with failing specs.

[gist]: https://gist.github.com/

## Cleaning up issues

* Issues that have no response from the submitter will be closed after 30 days.
* Issues will be closed once they're assumed to be fixed or answered. If the
maintainer is wrong, it can be opened again.
* If your issue is closed by mistake, please understand and explain the issue.
We will happily reopen the issue.

## Submitting a Pull Request
1. [Fork][fork] the [official repository][repo].
2. [Create a topic branch.][branch]
3. Implement your feature or bug fix.
4. Add, commit, and push your changes.
5. [Submit a pull request.][pr]

## Notes
* Please add tests if you changed code. Contributions without tests won't be accepted.
* If you don't know how to add tests, please put in a PR and leave a comment
asking for help. We love helping!
* Please don't update the Gem version.

[repo]: https://github.com/tongueroo/lono/tree/master
[fork]: https://help.github.com/articles/fork-a-repo/
[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
[pr]: https://help.github.com/articles/using-pull-requests/

Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md
2 changes: 2 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ credits: 'BoltOps, LLC'
markdown: kramdown
permalink: pretty

gh_url: "https://github.com/tongueroo/lono"

collections:
docs:
name: "Documentation"
Expand Down
5 changes: 3 additions & 2 deletions docs/_includes/content.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@
<div class="container">
<div class="row">
<div class="col-md-9 content-body">
<h2>{{ page.title }}</h2>
{{ content }}
<h2>{{ page.title }}</h2>
{{ content }}
{% include edit-on-github.html %}
</div>
{% include subnav.html %}
</div>
Expand Down
14 changes: 14 additions & 0 deletions docs/_includes/css/lono.css
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,17 @@ ul.tools li {
color: #fff;
background-color: #{{ site.data.template.color.primary }};
}

.edit-on-github {
font-size: 0.9em;
border-top: thin solid white;
border-bottom: thin solid white;
padding: 20px 0;
}

.edit-on-github h2,
.edit-on-github p,
.edit-on-github li {
font-size: 1.5em;
}

11 changes: 11 additions & 0 deletions docs/_includes/edit-on-github.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<div class="edit-on-github">

<h2>Edit this page</h2>
<p>See an typo or an error? Improve this page! This website is available on <a href="{{ site.gh_url }}">GitHub</a> and contributions are appreciated.
</p>
<ul>
<li><a href="{{ site.gh_url }}/blob/master/docs/{{ page.path }}" target="_blank">Suggest an edit to this page</a> (here's the <a href="{{ site.gh_url }}/blob/master/CONTRIBUTING.md" target="_blank">contributing guide</a>).</li>
<li><a href="{{ site.gh_url }}/issues/new?body=This%20issue%20is%20about%20<http://lono.cloud{{ page.url }}>%20(source%20file%3A%20<{{ site.gh_url }}/blob/master/docs/{{ page.path }}>)" target="_blank">Open an issue about this page</a> to report a problem.</li>
</ul>

</div>

0 comments on commit 81c54c1

Please sign in to comment.