yetangitu/photo-documentation
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

updated docs guide to reflect this repo

Browse source
This commit is contained in:
Sujin/Sushi 2013-01-30 11:17:32 -05:00
parent 830475662c
commit ffb3beef7a
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/contribute/documentation.markdown
View file

@ -7,10 +7,10 @@ We're always looking for writers to contribute to our documentation. If you can
## Deciding what to contribute
We currently have documentation for the API and setting up OpenPhoto on a variety of servers (including shared hosting services), along with FAQs for the hosted and self-hosted sites. You can contribute by adding to these guides or by adding your own guide--for example, how to install OpenPhoto on your webhost. Your contributions will help users of the present and future who have the same questions.
All of this documentation is in the frontend repository under the Documentation folder. You can also contribute to the copy for theopenphotoproject.org, which is stored in <a href="https://github.com/photo/community/">the community repository</a>. We have <a href="https://github.com/photo/frontend/issues?labels=Documentation&page=1&state=open">issues tagged documentation on Github</a>, but every area of the project can benefit from better documentation. Choose something you know about and start writing.
All of this documentation is <a href="https://github.com/photo/documentation">in the documentation repository</a> under the docs folder. We have <a href="https://github.com/photo/frontend/issues?labels=Documentation&page=1&state=open">issues tagged documentation on Github</a>, but every area of the project can benefit from better documentation. Choose something you know about and start writing.
## Forking the OpenPhoto repository
Before you start writing, you need to fork the repository you'll be working from. You can fork the repository right from the main OpenPhoto repository page by clicking the "Fork" button. If you plan on writing your documentation directly in Github, that's all you need to do. If you want to work from your local copy of the repository, <a href="https://help.github.com/articles/fork-a-repo">Github explains how to clone a repository</a>.
Before you start writing, you need to fork the documentation repository. You can fork the repository right from the main OpenPhoto repository page by clicking the "Fork" button. If you plan on writing your documentation directly in Github, that's all you need to do. If you want to work from your local copy of the repository, <a href="https://help.github.com/articles/fork-a-repo">Github explains how to clone a repository to your own machine</a>.
## Writing the documentation
We write our documentation in Github Standard Markdown and save the files as .Markdown files. If you're familiar with Markdown and Github, go ahead and fork OpenPhoto, then write your contribution in a text editor of your choice. If you're not, you may want to take a look at <a href="http://github.github.com/github-flavored-markdown/">Github's explanation of Markdown</a> as well as the source of OpenPhoto's documentation pages on Github.