Skip to content

Commit 7394ee6

Browse files
committed
Finalize text
1 parent 586d9db commit 7394ee6

4 files changed

Lines changed: 9 additions & 7 deletions

File tree

_learn/01-sphinx-python-rtd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ You can also get familiar with [ReStructured text](http://docutils.sourceforge.n
152152
$ make html
153153
```
154154
1. In your browser, refresh the `build/html/index.html` page to see the new Contents with two entries linked.
155-
1. Make sure you commit your changes to the Git repository by following the steps in "Working with content in GitHub repositories."
155+
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/).
156156
157157
## Additional resources
158158

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,12 @@ Once you've prepared your environment, you can build locally and review the site
167167
1. Use the **Server address** URL `http://127.0.0.1:4000/latest/` in a browser to preview the content.
168168

169169
1. Press `Ctrl+C` in the serve terminal to stop the server.
170+
> ***TIP***
171+
> Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output as you write. That said, if you change the `_config.yml` file, you must stop (ctrl-c) and then re-run the serve command to see changes.
170172
171-
> ***TIP***
172-
> Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output as you write. That said, if you change the `_config.yml` file, you must stop (ctrl-c) and then re-run the serve command to see changes.
173+
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/).
173174

174-
# Additional resources
175+
## Additional resources
175176

176177
[Markdown reference](http://commonmark.org/help/)
177178
[Documentation Theme for Jekyll](https://idratherbewriting.com/documentation-theme-jekyll/)

_learn/03-hugo-go-netlify.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ For Hugo, it's important to know that draft pages are only served when using the
108108
1. Open the **Web Server** URL, `http://localhost:1313/` in your local browser to view the site.
109109

110110
1. Press `Ctrl+C` in the server terminal to stop the Hugo server.
111+
1. You can add your files to a Git commit. Refer to [Working with content in GitHub repositories](https://docslikecode.com/learn/04-add-content-workflow/) for a documentation workflow with your Hugo site.
111112

112113
## Modify the Hugo theme
113114

_learn/05-cd-for-docs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Once you have a simple set of pages, you can set up continuous deployment on the
2828
1. Once you have a connected account, go to your profile on readthedocs.org and click **My Projects** to see a list of your repositories that Read the Docs service can access.
2929
1. To import your new project, click the **+** import icon next to the repository name. Click **Import Manually** if you do not see the repository listed after refreshing your accounts.
3030

31-
### CICD: Deploy a Sphinx project to readthedocs.org
31+
### Next: Deploy a Sphinx project to readthedocs.org
3232

3333
When you have a local project you want to deploy to a web site, you can set up the configuration for Continuous Deployment (CD) on readthedocs.org.
3434

@@ -55,7 +55,7 @@ Since this lesson is intended to be prescriptive, let's go through the manual se
5555
}
5656
```
5757

58-
## CICD: Deploy a Jekyll Project using GitHub Pages
58+
## Deploy a Jekyll Project using GitHub Pages
5959

6060
[GitHub Pages](https://pages.github.com/) is a hosted offering from GitHub itself so you can make web sites by building from GitHub repositories. For your GitHub account, you get one site and with an organization account you get another site, plus you can have unlimited project sites.
6161

@@ -78,7 +78,7 @@ remote_theme: "mmistakes/minimal-mistakes"
7878
By default, you are specifying the `master` branch of the Minimal Mistakes theme with this configuration. You can also "pin" to a specific release by using `"mmistakes/minimal-mistakes@4.9.0"` instead of `"mmistakes/minimal-mistakes"`. I'd recommend using a specific release if you have an active docs site because it helps you with troubleshooting output. Your output remains stable when you pin to a release value and you can test first before a theme upgrade.
7979
1. Create a commit and push these changes to your GitHub repository. Once merged to the branch configured in your repo, the changes show up in a few seconds at username.github.io/project-name.
8080

81-
## CICD: Deploy a Hugo Project using Netlify
81+
## Deploy a Hugo Project using Netlify
8282

8383
Once you have a Hugo site working locally, you can set up continuous deployment on Netlify with a free account.
8484

0 commit comments

Comments
 (0)