From 59777f47259f89bdc08d90c1abb21518cf722fd9 Mon Sep 17 00:00:00 2001 From: Seonaid Date: Fri, 21 Jan 2022 11:45:52 -0500 Subject: [PATCH] Add link to project, update documentation about how to update documentation. --- docs/content/documentation/_index.md | 8 ++------ docs/layouts/partials/menu-footer.html | 4 ++++ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/documentation/_index.md b/docs/content/documentation/_index.md index ee6facc..ab4b950 100644 --- a/docs/content/documentation/_index.md +++ b/docs/content/documentation/_index.md @@ -19,15 +19,11 @@ $ git clone --recursive https://gitlab.com/consensus.enterprises/drumkit.git $ cd drumkit $ git remote add sandbox https://gitlab.com//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 diff --git a/docs/layouts/partials/menu-footer.html b/docs/layouts/partials/menu-footer.html index cbd44ea..9650be1 100644 --- a/docs/layouts/partials/menu-footer.html +++ b/docs/layouts/partials/menu-footer.html @@ -1,3 +1,7 @@ Consensus Enterprises


+ +

Access the original project files at GitLab

+
+

Built with a fork of the Learn theme for Hugo