Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 118 lines (68 sloc) 4.636 kB
db1fe4d adding README
Mark Phillips authored
1 # The Riak Wiki
2
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
3 This repo holds all the content (and other bits) for the most-excellent Riak wiki, located at [wiki.basho.com][basho-wiki].
db1fe4d adding README
Mark Phillips authored
4
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
5 We are using [Gollum][gollum] and [Gollum-Site][gol-site] to generate the wiki. Gollum is a great piece of open source software released by the GitHub team that lets you maintain and build wikis from the contents of a Git repo.
db1fe4d adding README
Mark Phillips authored
6
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
7 `gollum-site` generates html from pages written in any format supported by Gollum (ASCIIDoc, Creole, Markdown, Textile, etc.).
db1fe4d adding README
Mark Phillips authored
8
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
9 <A name="contrib">
db1fe4d adding README
Mark Phillips authored
10 ## How to Contribute
11
12 Part of the reason we switched to Gollum and GitHub for the Riak Wiki was to make it easier for people to contribute. So, treat this repo much like you would a code repo: If you have a change (be a minor edit or an entirely new page full of Python client code snippets), simply:
13
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
14 1. [Fork this repo][forking]
15
f307ab3 @sgonyea More changes, listing quality spec
sgonyea authored
16 2. [Build a local copy][build]
17
18 3. Create a new Branch:
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
19
20 git checkout -b <branch-name>
21
f307ab3 @sgonyea More changes, listing quality spec
sgonyea authored
22 4. Add your changes
23
24 5. Run the specs and fix any formatting issues
25
26 rake spec
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
27
f307ab3 @sgonyea More changes, listing quality spec
sgonyea authored
28 6. Commit changes to your branch
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
29
f307ab3 @sgonyea More changes, listing quality spec
sgonyea authored
30 7. [Send us a pull request][pull-req]
db1fe4d adding README
Mark Phillips authored
31
f307ab3 @sgonyea More changes, listing quality spec
sgonyea authored
32 If it's a small or obvious change, we're likely to merge it right away. If we have questions, we'll communicate with you using the pull request's issue page.
db1fe4d adding README
Mark Phillips authored
33
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
34 The [Gollum README][gol-read] provides a great introduction to using the wiki system.
db1fe4d adding README
Mark Phillips authored
35
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
36 **Anyone can contribute to the Riak Wiki via the process outlined above. That said, there is a group of non-Basho developers who have commit access to this repo and can edit it directly. We call them _Community Wiki Committers_. [See this page][day-labor] if you're interested in becoming one.**
db1fe4d adding README
Mark Phillips authored
37
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
38 <A name="build">
7d08417 @dreverri minor tweaks to README
dreverri authored
39 ## Building the Wiki Locally
db1fe4d adding README
Mark Phillips authored
40
41 If you want to build and view the Riak Wiki locally, here is what you need to do:
42
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
43 1. Clone this repo:
44
45 git clone git://github.com/basho/riak_wiki.git
46
47 2. Ensure that you have [Bundler][bundler] installed:
7c587ab @dreverri Additional README tweaks
dreverri authored
48
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
49 gem install bundler
7c587ab @dreverri Additional README tweaks
dreverri authored
50
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
51 3. Install all pre-requisite gems:
7c587ab @dreverri Additional README tweaks
dreverri authored
52
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
53 bundle install
7c587ab @dreverri Additional README tweaks
dreverri authored
54
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
55 4. Generate the site and start a local server (This will take a minute. Don't fret.)
7c587ab @dreverri Additional README tweaks
dreverri authored
56
079098f @schofield added gollum-site serve --watch to readme
schofield authored
57 gollum-site generate # Will generate the files
58 gollum-site serve # Will start the gollum-site server
59 gollum-site serve --watch # Will start the gollum-site server and will regenerate the site
60 # when changes are made
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
61
62 5. Navigate to <http://localhost:8000/> (Default) to access a fully-functional copy of the Riak Wiki.
63
1b7d60d adding publish instructions to README
Mark Phillips authored
64 ## Updating wiki.basho.com
65
66 After adding new content or updating existing content in the wiki repo, it then needs to be pushed live to wiki.basho.com. We do this using a post-receive hook [(written by Basho's Dan Reverri)](https://github.com/dreverri/repo-sync-webhook) and the "publish" branch. Here's the process to update the live site. **(Only people who have commit access to this repo will be able to do this.)**
67
68 1. Make sure lastest changes are merged or committed to master branch
69
70 2. Checkout "publish" branch
71
72 `git checkout publish`
73
74 3. Merge changes from master into publish
75
76 `git merge master`
77
78 4. Push changes back to publish branch
79
80 `git push origin publish`
81
0f8fe80 Fixing small typo
Mark Phillips authored
82 After you merge your changes into publish and push them back to the repo, the post-receive hook will fire and wiki.basho.com should be updated
1b7d60d adding publish instructions to README
Mark Phillips authored
83 within several minutes.
84
85
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
86 <A name="feedback">
db1fe4d adding README
Mark Phillips authored
87 ## Issues, Questions, Comments, Etc.
88
93c1dc3 @sgonyea Formatting
sgonyea authored
89 * Send Email to [mark@basho.com][phark]
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
90
91 * Use the [Riak Mailing List][mail-list]
92
93 * Create a new [Issue][issues]
94
d7a18b6 @seancribbs According to the CC license, give attribution.
seancribbs authored
95 ## Credits
96
97 Includes [icons from famfamfam][silk].
98
905ab87 @ian-plosker Added license info to the README
ian-plosker authored
99 ## License
100
101 The Riak Wiki is licensed under a [Creative Commons Attribution 3.0 Unported License][license].
102
a7d02c1 @sgonyea Bunch of README changes
sgonyea authored
103 [phark]: mailto:mark@basho.com "Mark"
104 [mail-list]: http://lists.basho.com/mailman/listinfo/riak-users_lists.basho.com "Riak-Users"
105 [issues]: https://github.com/basho/riak_wiki/issues "Riak-Wiki Issues Page"
106 [forking]: http://help.github.com/forking/ "Github Forking Guide"
107 [pull-req]: http://help.github.com/pull-requests/ "Github Pull-Requests Guide"
108 [build]: #build "Building the Wiki"
109 [bundler]: https://github.com/carlhuda/bundler/ "Bundler"
110 [gol-read]: https://github.com/github/gollum/blob/master/README.md "Gollum README"
111 [day-labor]: http://wiki.basho.com/Contributing-to-the-Riak-Wiki.html "Riak Contributors"
112 [gollum]: https://github.com/github/gollum "Gollum Repo"
113 [gol-site]: https://github.com/dreverri/gollum-site "Gollum-Site Repo"
114 [basho-wiki]: http://wiki.basho.com "Basho Wiki"
d7a18b6 @seancribbs According to the CC license, give attribution.
seancribbs authored
115 [silk]: http://www.famfamfam.com/lab/icons/silk/ "FamFamFam Silk Icons"
905ab87 @ian-plosker Added license info to the README
ian-plosker authored
116 [license]: http://creativecommons.org/licenses/by/3.0/
117
Something went wrong with that request. Please try again.