From: spf13 Date: Wed, 11 Dec 2013 00:38:52 +0000 (-0500) Subject: Adding community section to the documentation X-Git-Tag: v0.10~91 X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=dd574628a074a7d8d13e712ba8af06eda642f82f;p=brevno-suite%2Fhugo Adding community section to the documentation --- diff --git a/docs/content/community/contributing.md b/docs/content/community/contributing.md new file mode 100644 index 00000000..3630779f --- /dev/null +++ b/docs/content/community/contributing.md @@ -0,0 +1,52 @@ +--- +title: "Contributing to Hugo" +date: "2013-07-01" +aliases: ["/doc/contributing/", "/meta/contributing/"] +groups: ["community"] +groups_weight: 30 +--- + +We welcome all contributions. If you want to contribute, all +that is needed is simply fork Hugo, make changes and submit +a pull request. **All pull requests must include comprehensive test cases.** +If you prefer, pick something from the roadmap +or contact [spf13](http://spf13.com) about what may make sense +to do next. + +## Overview + +1. Fork Hugo from https://github.com/spf13/hugo +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Commit passing tests to validate changes. +5. Push to the branch (`git push origin my-new-feature`) +6. Create new Pull Request + + +# Building from source + +### Clone locally (for contributors): + + git clone https://github.com/spf13/hugo + cd hugo + go get + +Because go expects all of your libraries to be found in either +$GOROOT or $GOPATH, it's helpful to symlink the project to one +of the following paths: + + * ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo + * ln -s /path/to/your/hugo $GOROOT/src/pkg/github.com/spf13/hugo + +### Running Hugo + + cd /path/to/hugo + go install github.com/spf13/hugo/hugolibs + go run main.go + +### Building Hugo + + cd /path/to/hugo + go build -o hugo main.go + mv hugo /usr/local/bin/ + diff --git a/docs/content/community/contributors.md b/docs/content/community/contributors.md new file mode 100644 index 00000000..75e185ea --- /dev/null +++ b/docs/content/community/contributors.md @@ -0,0 +1,14 @@ +--- +title: "Contributors" +date: "2013-07-01" +aliases: ["/doc/contributors/", "/meta/contributors/"] +groups: ["community"] +groups_weight: 40 +--- + +Hugo was built with love and golang by: + +* Steve Francia - [spf13](https://github.com/spf13) +* Noah Campbell - [noahcampbell](https://github.com/noahcampbell) +* [Many more](http://github.com/spf13/hugo/graphs/contributors) + diff --git a/docs/content/community/hall-of-fame.md b/docs/content/community/hall-of-fame.md new file mode 100644 index 00000000..d6b9ab19 --- /dev/null +++ b/docs/content/community/hall-of-fame.md @@ -0,0 +1,17 @@ +--- +title: "Hall of Fame" +date: "2013-07-01" +groups: ["community"] +groups_weight: 20 +--- + +Here we have listed sites built using Hugo. + +If you want to be added to this page please send a [pull request](https://github.com/spf13/hugo/pulls). + + + +| **Site** | **Source** | **License** | +| ------------------------------- | --------------------------------------------- | -----------: | +| [hugo](http://hugo.spf13.com) | [source](http://github.com/spf13/hugo/docs) | SIMPL | +| [spf13](http://spf13.com) | [source](http://github.com/spf13/spf13.com) | MIT | diff --git a/docs/content/community/mailing-list.md b/docs/content/community/mailing-list.md new file mode 100644 index 00000000..23767bb4 --- /dev/null +++ b/docs/content/community/mailing-list.md @@ -0,0 +1,34 @@ +--- +title: "Mailing List" +date: "2013-07-01" +groups: ["community"] +groups_weight: 10 +--- + +Hugo has two mailing lists: + +### Announcements +Very low traffic. Only releases will be emailed here. + +https://groups.google.com/forum/#!forum/hugo-announce + +### Discussion +For all questions and discussions: + +https://groups.google.com/forum/#!forum/hugo-discuss + +# Other Resources + +### GoNuts + +For general go questions or discussion please refer to the go mailing list. + +https://groups.google.com/forum/#!forum/golang-nuts + +### Github Issues + +https://github.com/spf13/hugo/issues + +### Twitter + +Hugo doesn't have it's own twitter handle, but feel free to tweet [@spf13](http://twitter.com/spf13). diff --git a/docs/content/meta/contributing.md b/docs/content/meta/contributing.md deleted file mode 100644 index a7bcbd81..00000000 --- a/docs/content/meta/contributing.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Contributing to Hugo" -date: "2013-07-01" -aliases: ["/doc/contributing/"] -groups: ["meta"] -groups_weight: 30 ---- - -We welcome all contributions. If you want to contribute, all -that is needed is simply fork Hugo, make changes and submit -a pull request. If you prefer, pick something from the roadmap -or contact [spf13](http://spf13.com) about what may make sense -to do next. - -## Overview -1. Fork it from https://github.com/spf13/hugo -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request - - -### Clone locally (for contributors): - - git clone https://github.com/spf13/hugo - cd hugo - go get - -Because go expects all of your libraries to be found in either -$GOROOT or $GOPATH, it's helpful to symlink the project to one -of the following paths: - - * ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo - * ln -s /path/to/your/hugo $GOROOT/src/pkg/github.com/spf13/hugo - -### Running Hugo - - cd /path/to/hugo - go install github.com/spf13/hugo/hugolibs - go run main.go - -### Building Hugo - - cd /path/to/hugo - go build -o hugo main.go - mv hugo /usr/local/bin/ - diff --git a/docs/content/meta/contributors.md b/docs/content/meta/contributors.md deleted file mode 100644 index 85b937f5..00000000 --- a/docs/content/meta/contributors.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Contributors" -date: "2013-07-01" -aliases: ["/doc/contributors/"] -groups: ["meta"] -groups_weight: 40 ---- - -Hugo was built with love and golang by: - -* Steve Francia - [spf13](https://github.com/spf13) -* Noah Campbell - [noahcampbell](https://github.com/noahcampbell) -* [Many more](http://github.com/spf13/hugo/graphs/contributors) - diff --git a/docs/layouts/chrome/header.html b/docs/layouts/chrome/header.html index f3a6b759..e0adaae9 100644 --- a/docs/layouts/chrome/header.html +++ b/docs/layouts/chrome/header.html @@ -10,6 +10,6 @@ {{ template "chrome/menu.html" . }} -
+
diff --git a/docs/layouts/chrome/menu.html b/docs/layouts/chrome/menu.html index 178265fb..3f38c2d0 100644 --- a/docs/layouts/chrome/menu.html +++ b/docs/layouts/chrome/menu.html @@ -53,6 +53,14 @@ {{ end }} +