Skip to content
This repository has been archived by the owner on Jun 24, 2020. It is now read-only.

Latest commit

 

History

History
34 lines (24 loc) · 1.34 KB

contribute.md

File metadata and controls

34 lines (24 loc) · 1.34 KB
Raw

Contribute to the Guides

We encourage our community to contribute to the Guides (in fact we encourage you to contribute to the Framework as well).

Maybe you've figured out something that you would like to share? ... Write a Tutorial!

See something that's not quite complete or even in the sections of the Guides?...Feel free to write or rewrite it for the rest of the community.

Simply fork this Nooku Guides repository, and when you are done with your (carefully reviewed) edits make a Pull Request so we can review.

<iframe src="http://ghbtns.com/github-btn.html?user=nooku&repo=guides.nooku.org&type=fork&size=large" height="30" width="100" frameborder="0" scrolling="0" style="width:100px; height: 30px;" allowTransparency="true"></iframe>

Gitbook

We use Gitbook to produce the guides, and suggest you get it as well. A good way to work is to use:

  $  cd /Your/Book/Path
  $  gitbook serve

And look at your work at http://localhost:4000 . As you edit and save your pages, your book will refresh in a moment as Gitbook detects a file change.

Some Writing Resources

Markdown http://daringfireball.net/projects/markdown/syntax

"Great Documentation" by Jacob Kaplan-Moss http://jacobian.org/writing/great-documentation/