diff --git a/_data/sidebar_doc.yml b/_data/sidebar_doc.yml index 1f6ad25..bd2c0af 100644 --- a/_data/sidebar_doc.yml +++ b/_data/sidebar_doc.yml @@ -236,6 +236,20 @@ entries: product: all version: all + - title: Handling reviews + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + - title: Commenting on files + url: /doc_commenting_on_files.html + audience: writers, designers + platform: all + product: all + version: all + - title: Publishing audience: writers, designers platform: all diff --git a/_data/urls.yml b/_data/urls.yml index 1339bf6..2b3c815 100644 --- a/_data/urls.yml +++ b/_data/urls.yml @@ -1,19 +1,4 @@ - - - - - - - - - - - - - - - - +end: '' titlepage: diff --git a/_layouts/page.html b/_layouts/page.html index 3b1b18a..9774f75 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -12,10 +12,11 @@ layout: default {% endif %} {% include toc.html %} - - {{content}} - + {% if site.github_editme_path %} + Edit me + {% endif %} + {{content}}
{% if page.tags != null %} @@ -23,7 +24,8 @@ layout: default {% include custom/conditions.html %} {% for tag in page.tags %} {% if projectTags contains tag %} - {% unless forloop.last %}{% endunless%} + + {{page.tagName}}{{tag}} {% endif %} {% endfor %} {% endif %} diff --git a/doc_commenting_on_files.md b/doc_commenting_on_files.md index f79e16d..50b1945 100644 --- a/doc_commenting_on_files.md +++ b/doc_commenting_on_files.md @@ -10,20 +10,23 @@ 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. +If you're using the doc as code approach, you might also consider using the same techniques for reviewing the doc as people use in reviewing code. This approach will involve using Github to edit the files. There's an Edit me button on each page on this theme. This button allows collaborators to edit the content on Github. +Here's the code for that button on the page.html layout: -## Add the edit button to your pages +``` + {% if site.github_editme_path %} + Edit me + {% endif %} +``` -## Instruct reviewers to authorize Prose.io +## Add reviewers as collaborators -People who plan to review the project need to authorize Prose.io on their computers. +If you want people to collaborate on your project so that their edits get committed to a branch on your project, you need to add them as collaborators. For your Github repo, click **Settings** and add the collaborators on the Collaborators tab using their Github usernames. -Authorize Prose.io +If you don't want to allow anyone to commit to your Github branch, don't add the reviewers as collaborators. When someone makes an edit, Github will fork the theme. The person's edit then will appear as a pull request to your repo. You can then choose to merge the change indicated in the pull or not. - -Authorze Prose.io on screen 2 diff --git a/doc_tags.md b/doc_tags.md index 793a7e7..53b0251 100644 --- a/doc_tags.md +++ b/doc_tags.md @@ -89,7 +89,7 @@ Tags have a few components. {% include custom/conditions.html %} {% for tag in page.tags %} {% if projectTags contains tag %} - {% unless forloop.last %}{% endunless%} + {{page.tagName}}{{tag}} {% endif %} {% endfor %} {% endif %} @@ -104,7 +104,7 @@ Tags have a few components. {% include custom/conditions.html %} {% for tag in page.tags %} {% if projectTags contains tag %} - {% unless forloop.last %}{% endunless%} + {{page.tagName}}{{tag}} {% endif %} {% endfor %} {% endif %}