summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-07-21 11:00:08 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-07-21 11:00:08 +0200
commitf387cb1b38fe8b09e4cbca9816caaa840de55c5b (patch)
tree55788e9ac44fc6833a35732a1a273f26a0d2811a /docs/README.md
parent40566ec98e23b93f538a50bc51f5c46d8e5056bc (diff)
parent2c0d1ccdcd95de0bddeb39dca2e4d08f0d8056d7 (diff)
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md39
1 files changed, 32 insertions, 7 deletions
diff --git a/docs/README.md b/docs/README.md
index 60a554e54..eba081c96 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,12 +2,37 @@
Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang.
-## Branches
+## Contributing
-* The `master` branch is the **current Hugo version** and will be auto-deployed to [gohugo.io/](https://gohugo.io/).
-* Anything not relevant to the current Hugo version goes into the `dev` branch.
-* Changes in [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs) will, in general, be merged once every release, but can be manually merged/cherry picked if needed. This goes both ways.
-* All contributions that is not tightly coupled with code changes, should be made directly to `hugoDocs`.
-* But we also merge PRs into [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs), but preferably changes that is related to the code in the PR itself
+We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our [contribution guide](https://gohugo.io/contribute/documentation/). We would love to hear from you.
-To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo).
+Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the [hugo](https://github.com/gohugoio/hugo) repository.
+
+*Pull requests shall **only** contain changes to the actual documentation. However, changes on the code base of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.*
+
+
+## Build
+
+To view the documentation site locally, you need to clone this repository with submodules:
+
+```bash
+git clone --recursive https://github.com/gohugoio/hugoDocs.git
+```
+
+Or if you already have a clone locally:
+
+```bash
+git submodule update --init
+```
+Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).
+
+Then to view the docs in your browser, run Hugo and open up the link:
+```bash
+hugo serve
+Started building sites ...
+.
+.
+Serving pages from memory
+Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
+Press Ctrl+C to stop
+```