Skip to content

Commit 7c1b977

Browse files
committed
Change from word-count to documentation-example
Update .gitignore to filter out vim temporary files.
1 parent a0d0cb6 commit 7c1b977

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
.jupyter_cache/
22
_build/
33
venv/
4+
.*.sw?

content/gh_workflow.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ counting the frequency distribution of words in a given file and some
3535
documentation generated using Sphinx. For bigger projects, we can have
3636
more source files.
3737
38-
**Step 1:** Go to the [word-count project template](https://github.com/coderefinery/word-count/generate)
38+
**Step 1:** Go to the [documentation-example project template](https://github.com/coderefinery/documentation-example/generate)
3939
on GitHub and create a copy to your namespace ("Generate", since this
4040
is a template repository).
4141
4242
**Clone the repository**
4343
44-
The repository contains following two folders, among few other files and folders:
44+
The repository contains following two folders, among few other files:
4545
- **source** folder contains the source code
4646
- **doc** folder contains the Sphinx documentation
4747
@@ -98,12 +98,12 @@ You don't need to understand all of the above, but you
9898
might spot familiar commands in the `run:` sections.
9999
100100
- Add, commit and push to GitHub
101-
- Check the action at `https://github.com/<myuser>/word-count/actions`.
101+
- Check the action at `https://github.com/<myuser>/documentation-example/actions`.
102102
Replace `<myuser>` with your GitHub username.
103103
104104
**Step 2:** Enable GitHub Pages
105105
106-
- Go to `https://github.com/<myuser>/word-count/settings/pages`
106+
- Go to `https://github.com/<myuser>/documentation-example/settings/pages`
107107
- In the "Source" section, choose "gh-pages" in the dropdown menu and click
108108
save
109109
- (You should be able to verify the pages deployment in the Actions list)
@@ -112,7 +112,7 @@ Replace `<myuser>` with your GitHub username.
112112
**Verify the result**
113113
114114
That's it! Your site should now be live on
115-
`https://<myuser>.github.io/word-count/` (replace username).
115+
`https://<myuser>.github.io/documentation-example/` (replace username).
116116
117117
**Verify refreshing the documentation**
118118

0 commit comments

Comments
 (0)