changing how github edit button works

This commit is contained in:
Tom Johnson
2015-09-18 14:24:57 -07:00
parent 9cdfb856ff
commit 5525a7a885
12 changed files with 39 additions and 11 deletions

View File

@ -11,7 +11,8 @@ homepage_title: Jekyll Documentation Theme — Designers
site_title: Jekyll Documentation Theme — Designers site_title: Jekyll Documentation Theme — Designers
disqus_shortname: idrbwjekyll disqus_shortname: idrbwjekyll
google_analytics: UA-66296557-1 google_analytics: UA-66296557-1
github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages
# don't use a slash before or after the above path. here's how this url gets written out in page.html: https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}
# variables # variables
sidebar_tagline: designers sidebar_tagline: designers

View File

@ -131,7 +131,7 @@ entries:
version: all version: all
- title: Tags - title: Tags
url: /tags.html url: /doc_tags.html
audience: writers, designers audience: writers, designers
platform: all platform: all
product: all product: all

View File

@ -12,9 +12,11 @@ layout: default
{% endif %} {% endif %}
{% include toc.html %} {% include toc.html %}
<a target="blank" href="http://prose.io/#tomjohnson1492/documentation-theme-jekyll/edit/gh-pages{{page.url | replace: '.html', '.md'}}"><button type="button" class="btn btn-default" aria-label="Left Align"><span class="glyphicon glyphicon-download-alt" aria-hidden="true"></span> Edit me</button></a> <a target="blank" href="https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}"><button type="button" class="btn btn-default" aria-label="Left Align"><span class="glyphicon glyphicon-download-alt" aria-hidden="true"></span> Edit me</button></a>
{{content}} {{content}}
<div class="tags"> <div class="tags">
{% if page.tags != null %} {% if page.tags != null %}
<b>Tags: </b> <b>Tags: </b>

View File

@ -10,6 +10,8 @@ homepage_title: Jekyll Documentation Theme &mdash; Designers
site_title: Jekyll Documentation Theme &mdash; Designers site_title: Jekyll Documentation Theme &mdash; Designers
disqus_shortname: idrbwjekyll disqus_shortname: idrbwjekyll
google_analytics: UA-66296557-1 google_analytics: UA-66296557-1
github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages
# don't use a slash before or after the above path. here's how this url gets written out in page.html: https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}
# variables # variables

View File

@ -10,6 +10,8 @@ homepage_title: Jekyll Documentation Theme &mdash; Writers
site_title: Jekyll Documentation Theme &mdash; Writers site_title: Jekyll Documentation Theme &mdash; Writers
disqus_shortname: idrbwjekyll disqus_shortname: idrbwjekyll
google_analytics: UA-66296557-1 google_analytics: UA-66296557-1
github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages
# don't use a slash before or after the above path. here's how this url gets written out in page.html: https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}
# variables # variables

View File

@ -0,0 +1,29 @@
---
title: Commenting on files
tags:
- navigation
keywords: "annotations, comments, feedback"
last_updated: "August 12, 2015"
summary: "You can add a button to your pages that allows people to add comments. Prose.io is an overlay on Github that would allow people to make comments in an easier interface."
published: true
---
## About the review process
If you're using the doc as code approach, you should also consider using the same techniques for reviewing the doc as people use in reviewing code. This approach will involve using Prose.io as an interface. Users will have Github accounts and authorize Prose.io to access their Github.
There's an Edit me button on each page on this theme. This button allows collaborators to edit the content on Github.
## Add the edit button to your pages
## Instruct reviewers to authorize Prose.io
People who plan to review the project need to authorize Prose.io on their computers.
<img src="{{ "/images/authorizeongithub.png" | prepend: site.baseurl }}" alt="Authorize Prose.io" />
<img src="{{ "/images/authorizegithubscreen2.png" | prepend: site.baseurl }}" alt="Authorze Prose.io on screen 2" />

View File

@ -8,8 +8,6 @@ summary: "The sidebar and top navigation bar read their values from yml files. T
published: true published: true
--- ---
{% comment %} small edit from saphira {% endcomment %}
## Sidebar overview ## Sidebar overview
To configure the sidebar, edit the values in the \_data/sidebar_doc.yml file. Follow the example in this theme. Note that YML spacing is picky. Each new level is two spaces indented. I usually just keep a template that shows all three levels and then copy and paste from it as needed. To configure the sidebar, edit the values in the \_data/sidebar_doc.yml file. Follow the example in this theme. Note that YML spacing is picky. Each new level is two spaces indented. I usually just keep a template that shows all three levels and then copy and paste from it as needed.

View File

@ -8,9 +8,6 @@ summary: "If you're not sure whether Jekyll and this theme will support your req
published: true published: true
--- ---
{%comment%} another comment from saphira {% endcomment %}
Before you get into exploring Jekyll as a potential platform for help content, you may be wondering if it supports some basic features. The following table shows what is supported in Jekyll and this theme. Before you get into exploring Jekyll as a potential platform for help content, you may be wondering if it supports some basic features. The following table shows what is supported in Jekyll and this theme.
Features | Supported | Notes Features | Supported | Notes

View File

@ -12,7 +12,6 @@ published: true
## Changing the top navigation ## Changing the top navigation
The top navigation reads from the \_data/topnav_doc.yml file. There are two *separate* sections: The top navigation reads from the \_data/topnav_doc.yml file. There are two *separate* sections:
{% comment %} this is a comment that I am adding here...{% endcomment %}
* `topnav` * `topnav`
* `topnav_dropdowns` * `topnav_dropdowns`

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -7,8 +7,6 @@ homepage: true
published: true published: true
--- ---
dan's comment...
## Overview ## Overview
This site provides documentation, training, and other notes for the Jekyll Documentation theme. There's a lot of information about how to do a variety of things here, and it's not all unique to this theme. But by and large, understanding how to do things in Jekyll depends on how your theme is coded. This site provides documentation, training, and other notes for the Jekyll Documentation theme. There's a lot of information about how to do a variety of things here, and it's not all unique to this theme. But by and large, understanding how to do things in Jekyll depends on how your theme is coded.