Skip to content

Commit

Permalink
Add link to project, update documentation about how to update documen…
Browse files Browse the repository at this point in the history
…tation.
  • Loading branch information
Seonaid committed Jan 21, 2022
1 parent 4dcc8a0 commit 59777f4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/content/documentation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,11 @@ $ git clone --recursive https://gitlab.com/consensus.enterprises/drumkit.git
$ cd drumkit
$ git remote add sandbox https://gitlab.com/<username>/drumkit.git
$ make hugo # this should install Hugo
$ cd docs # The docs site is contained inside the drumkit project
$ hugo serve
```

Your local Drumkit docs site should now be available for browsing:
[http://127.0.0.1:8000/](http://localhost:1313/). When you find a typo, an
error, unclear or missing explanations or instructions, hit ctrl-c, to stop the
server, and start editing. Find the page you’d like to edit; everything is in
the `docs/content/` directory. Make your changes, commit and push them, and start a pull
request:
Your local Drumkit docs site should now be available for browsing. The default address is [http://localhost:1313/](http://localhost:1313/), but hugo will give you the port when it starts. (Sometimes 1313 is already in use, and then it uses a different port). When you find a typo, an error, unclear or missing explanations or instructions, hit ctrl-c, to stop the server, and start editing. Find the page you’d like to edit; everything is in the `docs/content/` directory. Make your changes, commit and push them, and start a pull request:

```console
$ git checkout -b fix_typo
Expand Down
4 changes: 4 additions & 0 deletions docs/layouts/partials/menu-footer.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<a href="http://consensus.enterprises/">Consensus Enterprises</a></p>
<br />

<p>Access the original project files at <a href="https://gitlab.com/consensus.enterprises/drumkit">GitLab</a> </p>
<br />

<p>Built with a <a href="https://gitlab.com/ConsensusID/misc/hugo-theme-osmium">fork</a> of the <a href="https://github.com/matcornic/hugo-theme-learn">Learn</a> theme for <a href="http://gohugo.io/">Hugo</a></p>

0 comments on commit 59777f4

Please sign in to comment.