diff --git a/_config.yml b/_config.yml index 41197a5..cb44b45 100644 --- a/_config.yml +++ b/_config.yml @@ -11,7 +11,8 @@ homepage_title: Jekyll Documentation Theme — Designers site_title: Jekyll Documentation Theme — Designers disqus_shortname: idrbwjekyll 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 sidebar_tagline: designers diff --git a/_data/sidebar_doc.yml b/_data/sidebar_doc.yml index 55f2e72..1f6ad25 100644 --- a/_data/sidebar_doc.yml +++ b/_data/sidebar_doc.yml @@ -131,7 +131,7 @@ entries: version: all - title: Tags - url: /tags.html + url: /doc_tags.html audience: writers, designers platform: all product: all diff --git a/_layouts/page.html b/_layouts/page.html index 9418b6d..3b1b18a 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -12,9 +12,11 @@ layout: default {% endif %} {% include toc.html %} - + {{content}} + +
{% if page.tags != null %} Tags: diff --git a/configs/config_designers.yml b/configs/config_designers.yml index f012ff8..ba9956c 100644 --- a/configs/config_designers.yml +++ b/configs/config_designers.yml @@ -10,6 +10,8 @@ homepage_title: Jekyll Documentation Theme — Designers site_title: Jekyll Documentation Theme — Designers disqus_shortname: idrbwjekyll 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 diff --git a/configs/config_writers.yml b/configs/config_writers.yml index 7db1d5c..ffbfa06 100644 --- a/configs/config_writers.yml +++ b/configs/config_writers.yml @@ -10,6 +10,8 @@ homepage_title: Jekyll Documentation Theme — Writers site_title: Jekyll Documentation Theme — Writers disqus_shortname: idrbwjekyll 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 diff --git a/doc_commenting_on_files.md b/doc_commenting_on_files.md new file mode 100644 index 0000000..f79e16d --- /dev/null +++ b/doc_commenting_on_files.md @@ -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. + +Authorize Prose.io + + + +Authorze Prose.io on screen 2 diff --git a/doc_sidebar_navigation.md b/doc_sidebar_navigation.md index 19fd72f..4632727 100644 --- a/doc_sidebar_navigation.md +++ b/doc_sidebar_navigation.md @@ -8,8 +8,6 @@ summary: "The sidebar and top navigation bar read their values from yml files. T published: true --- - -{% comment %} small edit from saphira {% endcomment %} ## 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. diff --git a/doc_supported_features.md b/doc_supported_features.md index 1288cc8..eec03ef 100644 --- a/doc_supported_features.md +++ b/doc_supported_features.md @@ -8,9 +8,6 @@ summary: "If you're not sure whether Jekyll and this theme will support your req 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. Features | Supported | Notes diff --git a/doc_top_navigation.md b/doc_top_navigation.md index 2ac77f9..1082e76 100644 --- a/doc_top_navigation.md +++ b/doc_top_navigation.md @@ -12,7 +12,6 @@ published: true ## Changing the top navigation 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_dropdowns` diff --git a/images/authorizegithubscreen2.png b/images/authorizegithubscreen2.png new file mode 100644 index 0000000..2f6b6ca Binary files /dev/null and b/images/authorizegithubscreen2.png differ diff --git a/images/authorizeongithub.png b/images/authorizeongithub.png new file mode 100644 index 0000000..9380f80 Binary files /dev/null and b/images/authorizeongithub.png differ diff --git a/index.md b/index.md index 7cab2d8..1fa0bf9 100644 --- a/index.md +++ b/index.md @@ -7,8 +7,6 @@ homepage: true published: true --- - -dan's comment... ## 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.