Skip to content

Commit 7e0c9e4

Browse files
annegentleannegentle
authored
Merge pull request #124 from justwriteclick/build
Add What's Next links and remove the Next/Prev links
2 parents 86d7869 + 74c0128 commit 7e0c9e4

9 files changed

Lines changed: 116 additions & 21 deletions

‎_learn/01-sphinx-python-rtd.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Set Up Sphinx with Python"
3+
layout: page
34
image:
45
path: /images/learn/sphinx-docs-page.png
56
thumbnail: /images/learn/python-logo400x200.png
@@ -154,7 +155,19 @@ You can also get familiar with [ReStructured text](http://docutils.sourceforge.n
154155
1. In your browser, refresh the `build/html/index.html` page to see the new Contents with two entries linked.
155156
1. Make sure you commit your changes to the Git repository by following the steps in [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/).
156157
157-
## Additional resources
158+
## What's next
158159
159-
[Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/)
160-
[ReStructured text documentation](http://docutils.sourceforge.net/rst.html)
160+
* [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/)
161+
* [Continuous Deployment (CD) for Documentation Sites](https://www.docslikecode.com/learn/05-cd-for-docs/)
162+
* [Set Up Automated Tests for Docs](https://www.docslikecode.com/learn/06-test-docs-as-code/)
163+
164+
## Evaluating options
165+
166+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
167+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
168+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)
169+
170+
## Additional references
171+
172+
* [Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/)
173+
* [ReStructured text documentation](http://docutils.sourceforge.net/rst.html)

‎_learn/02-jekyll-ruby-gh-pages.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Set Up Jekyll with Ruby"
3+
layout: page
34
image:
45
path: /images/learn/jekyll-docs-page.png
56
thumbnail: /images/learn/ruby-logo400x200.png
@@ -178,9 +179,21 @@ Once you've prepared your environment, you can build locally and review the site
178179
179180
1. Don't forget to add the files to a commit and then commit the changes so that you can track the changes and work with others on GitHub. Refer to [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/).
180181

181-
## Additional resources
182+
## What's next
182183

183-
[Markdown reference](http://commonmark.org/help/)
184-
[Documentation Theme for Jekyll](https://idratherbewriting.com/documentation-theme-jekyll/)
185-
[Lynda.com Web foundations, GitHub Pages](https://www.lynda.com/Web-Development-tutorials/GitHub-pages/609031/654613-4.html)
186-
[Jekyll documentation about GitHub Pages](https://jekyllrb.com/docs/github-pages/)
184+
* [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/)
185+
* [Continuous Deployment (CD) for Documentation Sites](https://www.docslikecode.com/learn/05-cd-for-docs/)
186+
* [Set Up Automated Tests for Docs](https://www.docslikecode.com/learn/06-test-docs-as-code/)
187+
188+
## Evaluating options
189+
190+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
191+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
192+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)
193+
194+
## Additional references
195+
196+
* [Markdown reference](http://commonmark.org/help/)
197+
* [Documentation Theme for Jekyll](https://idratherbewriting.com/documentation-theme-jekyll/)
198+
* [Lynda.com Web foundations, GitHub Pages](https://www.lynda.com/Web-Development-tutorials/GitHub-pages/609031/654613-4.html)
199+
* [Jekyll documentation about GitHub Pages](https://jekyllrb.com/docs/github-pages/)

‎_learn/03-hugo-go-netlify.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: "Set Up Hugo"
2+
title: "Set Up Hugo with Go"
3+
layout: page
34
image:
45
path: /images/learn/hugo-docs-page.png
56
thumbnail: /images/learn/go-logo400x200.png
@@ -125,7 +126,19 @@ themeVariant = "green"
125126
home = [ "HTML", "RSS", "JSON"]
126127
```
127128

128-
## Additional resources
129+
## What's next
129130

130-
[Hugo Quickstart](https://gohugo.io/getting-started/quick-start/)
131-
[Hugo Themes web site](https://themes.gohugo.io/)
131+
* [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/)
132+
* [Continuous Deployment (CD) for Documentation Sites](https://www.docslikecode.com/learn/05-cd-for-docs/)
133+
* [Set Up Automated Tests for Docs](https://www.docslikecode.com/learn/06-test-docs-as-code/)
134+
135+
## Evaluating options
136+
137+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
138+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
139+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)
140+
141+
## Additional references
142+
143+
* [Hugo Quickstart](https://gohugo.io/getting-started/quick-start/)
144+
* [Hugo Themes web site](https://themes.gohugo.io/)

‎_learn/04-add-content-workflow.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Working with content in GitHub repositories"
3+
layout: page
34
image:
45
path: /images/learn/octocat.png
56
thumbnail: /images/learn/octocat-github-logo400x200.png
@@ -138,3 +139,19 @@ When you're the only person working in a repo, you can use a simple workflow, wh
138139
```
139140
$ git checkout master; git remote update; git pull origin master
140141
```
142+
143+
## What's next
144+
145+
* [Continuous Deployment (CD) for Documentation Sites](https://www.docslikecode.com/learn/05-cd-for-docs/)
146+
* [Set Up Automated Tests for Docs](https://www.docslikecode.com/learn/06-test-docs-as-code/)
147+
148+
## Evaluating options
149+
150+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
151+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
152+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)
153+
154+
## Additional references
155+
156+
* [Comparing Git Workflows](https://www.atlassian.com/git/tutorials/comparing-workflows)
157+
* [Git Branching - Branching Workflows](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows)

‎_learn/05-cd-for-docs.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Continuous Deployment (CD) for Documentation Sites"
3+
layout: page
34
image:
45
path: /images/learn/netlify-logo400x200.png
56
thumbnail: /images/learn/netlify-logo400x200.png
@@ -101,8 +102,18 @@ You can also deploy documentation sites using free hosting options as alternativ
101102

102103
* [Netlify](https://www.netlify.com) provides the same capability as GitHub and GitLab with the Ruby gem configuration described in [this tutorial](https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/) and in the [Minimal Mistakes theme documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#ruby-gem-method).
103104

104-
## Additional resources
105+
## What's next
105106

106-
[TravisCI Core Concepts for Beginners](https://docs.travis-ci.com/user/for-beginners)
107+
* [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/)
108+
* [Set Up Automated Tests for Docs](https://www.docslikecode.com/learn/06-test-docs-as-code/)
107109

108-
[Convert AsciiDoc to HTML/PDF & publish to GitHub Pages with Travis CI and Asciidoctor Docker containers](http://mgreau.com/posts/2016/03/28/asciidoc-to-gh-pages-with-travis-ci-docker-asciidoctor.html)
110+
## Evaluating options
111+
112+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
113+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
114+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)
115+
116+
## Additional references
117+
118+
* [TravisCI Core Concepts for Beginners](https://docs.travis-ci.com/user/for-beginners)
119+
* [Convert AsciiDoc to HTML/PDF & publish to GitHub Pages with Travis CI and Asciidoctor Docker containers](http://mgreau.com/posts/2016/03/28/asciidoc-to-gh-pages-with-travis-ci-docker-asciidoctor.html)

‎_learn/06-test-docs-as-code.md‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Set Up Automated Tests for Docs"
3+
layout: page
34
image:
45
path: /images/learn/travis-ci-logo400x200.png
56
thumbnail: /images/learn/travis-ci-logo400x200.png
@@ -129,12 +130,21 @@ bundle exec htmlproofer ./_site
129130

130131
Look for more inspiration beyond link checking in the additional resources section. Enjoy higher-quality doc builds with some quality tests up front!
131132

132-
## Additional resources
133+
## What's next
133134

134-
[Test the Docs](https://testthedocs.org/)
135+
* [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/)
136+
* [Continuous Deployment (CD) for Documentation Sites](https://www.docslikecode.com/learn/05-cd-for-docs/)
135137

136-
Pantheon docs examples
137-
* [Merge conflict test](https://github.com/pantheon-systems/documentation/blob/master/scripts/merge_conflicts.sh)
138-
* [CircleCI example configuration](https://github.com/pantheon-systems/documentation/blob/master/circle.yml)
138+
## Evaluating options
139139

140-
[How we spotted--and fixed--11 errors in our docs with our new markdown proofer](https://circleci.com/blog/markdown-proofer/)
140+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
141+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
142+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)
143+
144+
## Additional references
145+
146+
* [Test the Docs](https://testthedocs.org/)
147+
* Pantheon docs examples
148+
* [Merge conflict test](https://github.com/pantheon-systems/documentation/blob/master/scripts/merge_conflicts.sh)
149+
* [CircleCI example configuration](https://github.com/pantheon-systems/documentation/blob/master/circle.yml)
150+
* [How we spotted--and fixed--11 errors in our docs with our new markdown proofer](https://circleci.com/blog/markdown-proofer/)

‎_learn/07-evaluating-ssg-themes.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Evaluating Static Site Generator themes"
3+
layout: page
34
image:
45
path: /images/learn/ssg-themes.png
56
thumbnail: /images/learn/ssg-themes400x225.png
@@ -49,3 +50,8 @@ How easy is it to upgrade the theme files? Can you make regular updates through
4950

5051
## Versions
5152
Many themes do not have a version picker by default. You might want a drop-down list or navigation that could include version. The Sphinx Read the Docs theme does have one and it works great. For Jekyll, look at the [versions-jekyll repository](https://github.com/justwriteclick/versions-jekyll) to see a couple of implementation ideas.
53+
54+
## Evaluating other options
55+
56+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)
57+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)

‎_learn/08-evaluating-table-layouts.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Evaluating table layouts and formatting"
3+
layout: page
34
image:
45
path: /images/learn/table-layout.png
56
thumbnail: /images/learn/table-layout400x225.png
@@ -46,3 +47,8 @@ If you also output PDF using LaTeX with Sphinx, be aware that there's a column s
4647
```
4748

4849
Your editor may also have helpful tools for managing tables, such as the [Markdown Table Editor in Atom](https://atom.io/packages/markdown-table-editor), which can resize all rows and columns while you type. Plus, it enables keybindings that you can use to navigate between cells and rows.
50+
51+
## Evaluating other options
52+
53+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
54+
* [Evaluating Static Site Generator search options](https://www.docslikecode.com/learn/09-ssg-search-implementations/)

‎_learn/09-ssg-search-implementations.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Evaluating Static Site Generator search options"
3+
layout: page
34
image:
45
path: /images/learn/ssg-search-options.png
56
thumbnail: /images/learn/ssg-search-options400x225.png
@@ -24,3 +25,8 @@ home = [ "HTML", "RSS", "JSON"]
2425
```
2526

2627
You can also configure Algolia, a software-as-a-service (SaaS) search solution, in Hugo, according to this [blog post](https://forestry.io/blog/search-with-algolia-in-hugo/).
28+
29+
## Evaluating other options
30+
31+
* [Evaluating Static Site Generator themes](https://www.docslikecode.com/learn/07-evaluating-ssg-themes/)
32+
* [Evaluating table layouts and formatting](https://www.docslikecode.com/learn/08-evaluating-table-layouts/)

0 commit comments

Comments
 (0)