Permalink
Browse files

Merge pull request #1064 from sushimustwrite/master

Why on earth did I put off merging this for so long? Merging.
  • Loading branch information...
2 parents 24a99b2 + 34c2298 commit 7a00d5d3e96d67b9629c6459feb2b7977cea7000 @sushimustwrite sushimustwrite committed Jan 27, 2013
@@ -4,7 +4,7 @@ Authentication using OAuth 1.0a
### Using OAuth (1.0a)
A full introduction to OAuth is beyond the scope of the OpenPhoto documentation.
-In all reality you probably don't need to understand the ins and outs of OAuth, just grab one of our libraries.
+In all reality you probably don't need to understand all the ins and outs of OAuth; just grab one of our libraries and start building.
* <a href="https://github.com/photo/openphoto-php">openphoto/openphoto-php</a> - Our PHP language binding.
* <a href="https://github.com/photo/openphoto-ruby">openphoto/openphoto-ruby</a> - Our Ruby language binding.
@@ -34,7 +34,7 @@ _Authentication: optional_
<a name="parameters"></a>
### Parameters
-1. returnSizes (optional), (i.e. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
+1. returnSizes (optional), (e.g. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
----------------------------------------
@@ -34,11 +34,11 @@ _Authentication: optional_
<a name="parameters"></a>
### Parameters
-1. returnSizes (optional), (i.e. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
+1. returnSizes (optional), (e.g. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes)
1. pageSize (optional), Number of photos to return per request.
1. page (optional), Page number when browsing through photos. Starts at 1.
-1. tags (optional), _i.e. dog,cat_ - A comma delimited string of strings.
+1. tags (optional), _e.g. dog,cat_ - A comma delimited string of strings.
----------------------------------------
@@ -65,7 +65,7 @@ The response is in a standard [response envelope](http://theopenphotoproject.org
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
-* _result_, A [Action][Action] object or FALSE on error
+* _result_, An [Action][Action] object or FALSE on error
<a name="sample"></a>
#### Sample
@@ -33,16 +33,16 @@ _Authentication: required_
### Parameters
1. permission (optional), 0 for private and 1 for public.
-1. title (optional), _i.e. My first day at work_ - A string title to describe the photo.
-1. description (optional), _i.e. A much longer description of my first day_ - A string to describe the photo in detail.
-1. tags (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings.
-1. tagsAdd (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings to be added.
-1. tagsRemove (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings to be removed.
-1. dateUploaded (optional), _i.e. 1311059035_ - A unix timestamp of the date the photo was uploaded
-1. dateTaken (optional), _i.e. 1311059035_ - A unix timestamp of the date the photo was taken which overrides EXIF data if present
-1. license (optional), _i.e. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license.
-1. latitude (optional), _i.e. 34.76_ - A decimal representation of latitude.
-1. longitude (optional), _i.e. -87.45_ - A decimal representation of longitude.
+1. title (optional), _e.g. My first day at work_ - A string title to describe the photo.
+1. description (optional), _e.g. A much longer description of my first day_ - A string to describe the photo in detail.
+1. tags (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings.
+1. tagsAdd (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings to be added.
+1. tagsRemove (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings to be removed.
+1. dateUploaded (optional), _e.g. 1311059035_ - A unix timestamp of the date the photo was uploaded
+1. dateTaken (optional), _e.g. 1311059035_ - A unix timestamp of the date the photo was taken which overrides EXIF data if present
+1. license (optional), _e.g. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license.
+1. latitude (optional), _e.g. 34.76_ - A decimal representation of latitude.
+1. longitude (optional), _e.g. -87.45_ - A decimal representation of longitude.
----------------------------------------
@@ -0,0 +1,40 @@
+# Contributing to OpenPhoto's Documentation
+
+We're working hard to make OpenPhoto the best photo software possible, and part of that is making sure it's well-documented and accessible to beginners and experts alike. Writing good documentation is a big step toward that goal, and what you see here is the beginning of that effort.
+
+We're always looking for writers to contribute to our documentation. If you can explain technical ideas clearly, we need you.
+
+## 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.
+
+## 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>.
+
+## 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.
+
+A few things to keep in mind while writing the documentation:
+* Remember that users of all skill levels will be reading the documentation. What you write should be accessible to all of them. This includes staying beginner- and expert-friendly, remaining gender-neutral, and being friendly and informative.
+* Use correct grammar and spelling. <a href="https://owl.english.purdue.edu/owl/section/1/5/">Here's a grammar guide</a> if you need a refresher.
+* Stay away from slang and other terms that don't translate well. This is for a couple for a reasons. First, OpenPhoto has an international userbase, and English may not be everyone's first language. Second, this makes translating easier when the time comes.
+
+## Committing your documentation
+When committing your documentation it's important to reference the GitHub issue you're fixing, if applicable. You can do it by adding a _#_ followed by the issue number.
+
+ # To simply reference an issue with a commit do this
+ git commit -m 'Addressing the foobar component but not yet finished. #123'
+
+ # To commit and close an issue do this
+ git commit -m 'Wrote the longest guide ever. Closes #123'
+
+Be descriptive, it helps a ton. If you're working on the Github website you can do this in the commit summary at the bottom of the page you're writing in. Once you've committed your code it's time to push it to GitHub.
+
+ git push origin master
+
+## Getting your change into the main OpenPhoto branch
+You can send your documentation to us by submitting a pull request. This way it can get reviewed and merged with the rest of the documentation. If you forked a copy of OpenPhoto to your local machine, <a href="http://help.github.com/send-pull-requests/">Github explains how to send a pull request with git.</a> If you wrote all the documentation through the Github website, you can press the Pull Request button that appears on the page containing your copy of the OpenPhoto repository.
+
+## Help! I'm stuck and I have questions
+If you have questions we're always around to help. We've got several contact options listed on the <a href="http://theopenphotoproject.org/contribute">contribute</a> page.
@@ -0,0 +1,26 @@
+Pro Accounts
+===========================
+
+## What do I get with a Trovebox Pro account?
+With a pro account, you get:
+* Unlimited photo uploads (Free users get 100 photo uploads/month)
+* Import from Flickr and Picasa as well as Facebook and Instagram
+* Switch storage options as many times as you wish (Free users can switch once)
+* Top level domain support at yourdomain.com
+
+<a href="https://trovebox.com/plans">Check out our chart</a> for the full breakdown.
+
+## How much does a Pro account cost?
+A Pro account costs $29.99 a year.
+
+## How do I upgrade from a free account to a Pro account?
+Visit https://trovebox.com/upgrade, enter your credit card info, and enjoy your Pro account!
+
+## How does unlimited space work with my storage service?
+We don't limit uploads for Pro users, but you may face limits from your storage provider. If we're your storage provider then everything is unlimited.
+
+## Do I have to renew manually every year?
+Nope. We'll alert you when your Pro account is going to renew.
+
+## What happens if my Pro subscription ends?
+Don't panic! Nothing has been deleted. You resume using a free account, though you're now subject to the free account limitations. You can still access all your photos, free or pro.
@@ -1,13 +1,22 @@
## Self-Hosted OpenPhoto FAQ
### How can I install OpenPhoto?
-We have lots of guides to help you through the installation process. <a href="http://theopenphotoproject.org/documentation">Check them out here</a>. We welcome <a href="http://github.com/photo/frontend">contributions on Github</a> if you see one that's incomplete.
+We have lots of guides to help you through the installation process. <a href="http://theopenphotoproject.org/documentation">Check them out here</a>. We welcome <a href="http://github.com/photo/frontend">contributions on Github</a> if you see one that's incomplete or want to add one.
+
+### I'm using a shared hosting webservice. Can I still install OpenPhoto?
+Yes, but you may have to configure some settings differently. Check out our <a href="https://github.com/photo/frontend/blob/master/documentation/guides/InstallationSharedHosting.markdown">shared hosting guide</a>. If you're using Dreamhost we have <a href="https://github.com/photo/frontend/blob/master/documentation/guides/InstallationDreamhost.markdown">a community-written guide for Dreamhost users</a>.
### Can I install OpenPhoto to a subdirectory of my site?
Not yet, but it's on our wishlist.
### How does support for multiple users work?
We support multiple users through separate domains. <a href="https://github.com/photo/frontend/issues/318">See this issue on why it works that way.</a>
+### What cloud services are supported for self-hosted sites?
+OpenPhoto currently supports Amazon S3 and Dropbox for self-hosted sites.
+
+### Can I import my photos from other photo sites?
+Yes, you can use the scripts available on our Github. We have <a href="https://github.com/photo/export-flickr">a Flickr export script</a> and an <a href="https://github.com/photo/import">import script</a> available on Github. You can also configure something like Ifttt or Pi.pe to continuously import photos from a site.
+
### Is your mobile app available for self-hosted users?
Yes! Download the app <a href="http://itunes.com/apps/theopenphotoapp">for iOS</a> or <a href="https://play.google.com/store/apps/details?id=me.openphoto.android.app">Android</a>.
@@ -18,4 +27,7 @@ This is normal. OpenPhoto configs are bound to a site, not a server. Since a sit
<a href="https://github.com/photo/frontend/issues">Report it as an issue at Github</a>. If you don't feel comfortable exposing a security issue, reach out to someone on the core team and email us individually.
### Something broke. How do I let you know?
-Check <a href="https://github.com/photo/frontend/issues">our issue tracker at Github</a> first; if the issue you're encountering isn't already there, then start a new issue and describe what you ran across.
+Check <a href="https://github.com/photo/frontend/issues">our issue tracker at Github</a> first; if the issue you're encountering isn't already there, then start a new issue and describe what you ran across. The more detail you can give us, the better.
+
+### Help! I'm stuck and I have questions.
+If you have questions we're always around to help. We've got several contact options listed on the <a href="http://theopenphotoproject.org/contribute">contribute</a> page.
@@ -13,16 +13,16 @@ This guide instructs you on how to install OpenPhoto on a Fedora server.
#### Database and File System Options
##### MySql
-You'll need to provide credentials for a MySql database. If the database doesn't already exist it will be created. If the user doesn't have `CREATE DATABASE` permissions then make sure it's already created.
+You'll need to provide credentials for a MySql database. If the database doesn't already exist it will be created. If the user doesn't have `CREATE DATABASE` permissions then make sure to create the database.
##### AWS
-If you're going to use AWS services then You'll need to be signed up for them.
+If you're going to use AWS services then you'll need to be signed up for them.
* http://aws.amazon.com/simpledb/
* http://aws.amazon.com/s3/
#### Server Packages and Modules
-Once you've confirmed that your cloud account is setup you can get started on your server. For that you'll need to have _Apache_, _PHP_ and _curl_ installed with a few modules.
+Once you've confirmed that your cloud account is set up, you can get started on your server. For that you'll need to have _Apache_, _PHP_ and _curl_ installed with a few modules.
yum groupinstall 'Development Tools'
yum groupinstall 'Development Libraries'
@@ -46,7 +46,7 @@ The _Apache 2_ user in Fedora 16 is `apache` so run the following commands to ta
git clone git://github.com/photo/frontend.git /var/www/yourdomain.com
chown -R apache: /var/www/yourdomain.com
-Assuming that this is a development machine you only need to make the config writable by the user Apache runs as. Most likely `apache`.
+Assuming that this is a development machine you only need to make the config writable by the user Apache runs as. This user is likely `apache`.
mkdir /var/www/yourdomain.com/src/userdata
mkdir /var/www/yourdomain.com/src/html/photos
@@ -81,8 +81,8 @@ Uncomment:
Comment:
- # 404 Not Found for ini files
- AliasMatch \.ini$ /404
+ # 404 Not Found for ini files
+ AliasMatch \.ini$ /404
### PHP
Oops, something went wrong.

0 comments on commit 7a00d5d

Please sign in to comment.