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

Normalizing and fixing links across pages in the documentation directory.

Browse source 
Gh-180
This commit is contained in:
Jaisen Mathai 2011-10-03 13:57:23 -07:00
parent d137139f38
commit ae0a402777
16 changed files with 48 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

16
documentation/api/Api.markdown
View file

@ -37,12 +37,12 @@ Every API endpoint returns a JSON response in a [standard envelope][Envelope].
1. [POST /tag/:id/update.json][PostTag] 1. [POST /tag/:id/update.json][PostTag]
Modify meta data for a user's tag. Modify meta data for a user's tag.
[Envelope]: api/Envelope.markdown [Envelope]: Envelope.markdown
[GetHelloWorld]: api/GetHelloWorld.markdown [GetHelloWorld]: GetHelloWorld.markdown
[GetPhotos]: api/GetPhotos.markdown [GetPhotos]: GetPhotos.markdown
[GetPhoto]: api/GetPhoto.markdown [GetPhoto]: GetPhoto.markdown
[GetTags]: api/GetTags.markdown [GetTags]: GetTags.markdown
[PostPhotoUpload]: api/PostPhotoUpload.markdown [PostPhotoUpload]: PostPhotoUpload.markdown
[PostTag]: api/PostTag.markdown [PostTag]: PostTag.markdown
[authentication]: api/Authentication.markdown [authentication]: Authentication.markdown
[oauth1.0a]: http://oauth.net/core/1.0a/ [oauth1.0a]: http://oauth.net/core/1.0a/

2
documentation/api/GetHelloWorld.markdown
View file

@ -74,7 +74,7 @@ The response is in a standard [response envelope][Envelope].
} }
} }
[Envelope]: api/Envelope.markdown [Envelope]: Envelope.markdown
[purpose]: #purpose [purpose]: #purpose
[endpoint]: #endpoint [endpoint]: #endpoint
[parameters]: #parameters [parameters]: #parameters

8
documentation/api/GetPhoto.markdown
View file

@ -100,8 +100,8 @@ The response is in a standard [response envelope][Envelope].
} }
} }
[Envelope]: api/Envelope.markdown [Envelope]: Envelope.markdown
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown [Photo]: ../schemas/Photo.markdown
[purpose]: #purpose [purpose]: #purpose
[endpoint]: #endpoint [endpoint]: #endpoint
[parameters]: #parameters [parameters]: #parameters
@ -110,5 +110,5 @@ The response is in a standard [response envelope][Envelope].
[example-php]: #example-php [example-php]: #example-php
[response]: #response [response]: #response
[sample]: #sample [sample]: #sample
[photogeneration]: faq/PhotoGeneration.markdown [photogeneration]: ../faq/PhotoGeneration.markdown
[ReturnSizes]: faq/ReturnSizes.markdown [ReturnSizes]: ../faq/ReturnSizes.markdown

2
documentation/api/GetPhotos.markdown
View file

@ -133,7 +133,7 @@ The response is in a standard [response envelope][Envelope].
] ]
} }
[Envelope]: ../api/Envelope.markdown [Envelope]: Envelope.markdown
[Photo]: ../schemas/Photo.markdown [Photo]: ../schemas/Photo.markdown
[purpose]: #purpose [purpose]: #purpose
[endpoint]: #endpoint [endpoint]: #endpoint

4
documentation/api/GetTags.markdown
View file

@ -94,8 +94,8 @@ The response is in a standard [response envelope][Envelope].
] ]
} }
[Envelope]: api/Envelope.markdown [Envelope]: Envelope.markdown
[Tag]: schemas/Tag.markdown [Tag]: ../schemas/Tag.markdown
[purpose]: #purpose [purpose]: #purpose
[endpoint]: #endpoint [endpoint]: #endpoint
[parameters]: #parameters [parameters]: #parameters

4
documentation/api/PostPhotoUpload.markdown
View file

@ -123,8 +123,8 @@ The response is in a standard [response envelope][Envelope].
} }
} }
[Envelope]: api/Envelope.markdown [Envelope]: Envelope.markdown
[Photo]: schemas/Photo.markdown [Photo]: ../schemas/Photo.markdown
[purpose]: #purpose [purpose]: #purpose
[endpoint]: #endpoint [endpoint]: #endpoint
[parameters]: #parameters [parameters]: #parameters

2
documentation/faq/Faq.markdown
View file

@ -63,5 +63,5 @@ You can set up the OpenPhoto software using [any of the guides][guides].
We are aiming to have it ready by the end of November (2011). We are aiming to have it ready by the end of November (2011).
[guides]: guides/Readme.markdown [guides]: ../guides/Guides.markdown

6
documentation/faq/PhotoGeneration.markdown
View file

@ -108,6 +108,6 @@ Additional options include `CR` and `BW`. `CR` tells the API to crop the photo t
For more information on the `returnSizes` parameter see our [documentation on returnSizes][ReturnSizes]. For more information on the `returnSizes` parameter see our [documentation on returnSizes][ReturnSizes].
[GetPhotos]: api/GetPhotos.markdown [GetPhotos]: ../api/GetPhotos.markdown
[GetPhoto]: api/GetPhoto.markdown [GetPhoto]: ../api/GetPhoto.markdown
[ReturnSizes]: faq/ReturnSizes.markdown [ReturnSizes]: ../faq/ReturnSizes.markdown

6
documentation/faq/ReturnSizes.markdown
View file

@ -36,6 +36,6 @@ Adding `xCR` means that the photo will be exactly _200px_ by _200px_ and cropped
### Accessing the paths in the response ### Accessing the paths in the response
The name of the URL attribute in the response is, by convention, `pathWxH` where `WxH` is the value passed in to returnSizes. The name of the URL attribute in the response is, by convention, `pathWxH` where `WxH` is the value passed in to returnSizes.
[GetPhoto]: api/GetPhoto.markdown [GetPhoto]: ../api/GetPhoto.markdown
[GetPhotos]: api/GetPhotos.markdown [GetPhotos]: ../api/GetPhotos.markdown
[photogeneration]: faq/PhotoGeneration.markdown [photogeneration]: ../faq/PhotoGeneration.markdown

10
documentation/guides/Guides.markdown
View file

@ -8,8 +8,8 @@ OpenPhoto / Guides
1. [Installation on Ubuntu with Cherokee][guideinstallubuntucherokee] 1. [Installation on Ubuntu with Cherokee][guideinstallubuntucherokee]
1. [Installation via Amazon EC2 OpenPhoto AMI][guideinstallamazonec2] 1. [Installation via Amazon EC2 OpenPhoto AMI][guideinstallamazonec2]
[guideinstallubuntuapache]: guides/InstallationUbuntuApache.markdown [guideinstallubuntuapache]: InstallationUbuntuApache.markdown
[guideinstallosxmacports]: guides/InstallationOSXMacports.markdown [guideinstallosxmacports]: InstallationOSXMacports.markdown
[guideinstallsuse]: guides/InstallationSUSE.markdown [guideinstallsuse]: InstallationSUSE.markdown
[guideinstallubuntucherokee]: guides/InstallationUbuntuCherokee.markdown [guideinstallubuntucherokee]: InstallationUbuntuCherokee.markdown
[guideinstallamazonec2]: guides/InstallationUsingOpenPhotoEC2-AMI.markdown [guideinstallamazonec2]: InstallationUsingOpenPhotoEC2-AMI.markdown

4
documentation/guides/InstallationUsingOpenPhotoEC2-AMI.markdown
View file

@ -54,7 +54,3 @@ Verify the apache user has write access to the /home/ubuntu/openphoto/src/config
ls -ld ./configs ls -ld ./configs
drwxr-xr-x 3 www-data www-data 4096 2011-08-20 02:37 configs drwxr-xr-x 3 www-data www-data 4096 2011-08-20 02:37 configs

6
documentation/schemas/Action.markdown
View file

@ -50,6 +50,6 @@ This includes comments and favorites and could include other social actions in t
* status, Binary value if the action is active or not * status, Binary value if the action is active or not
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown [User]: User.markdown
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown [Photo]: Photo.markdown
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown [Action]: Action.markdown

6
documentation/schemas/Group.markdown
View file

@ -29,7 +29,7 @@ A Group consists of an `id`, `name` and array of `email addresses`.
* name, the name of the group * name, the name of the group
* members: a set of email addresses who belong to this group * members: a set of email addresses who belong to this group
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown [User]: User.markdown
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown [Photo]: Photo.markdown
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown [Action]: Action.markdown

6
documentation/schemas/Photo.markdown
View file

@ -102,6 +102,6 @@ This includes EXIF information from the photo, tags and URLs to all versions of
* pathBase, The URL of the base version of the photo, used for photo generation * pathBase, The URL of the base version of the photo, used for photo generation
* pathWxH, A pseudo key which represents any resized version of a photo and it's URL * pathWxH, A pseudo key which represents any resized version of a photo and it's URL
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown [User]: User.markdown
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown [Photo]: Photo.markdown
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown [Action]: Action.markdown

10
documentation/schemas/Schemas.markdown
View file

@ -23,13 +23,15 @@ Since a [Photo][Photo] object has a predictable set of properties it means that
### Available schemas ### Available schemas
1. [User][User] - Settings for a user. 1. [User][User] - Settings for a user.
1. [Credential][Credential] - Properties for a user's OAuth credential.
1. [Photo][Photo] - Properties for a single photo. 1. [Photo][Photo] - Properties for a single photo.
1. [Action][Action] - Comments and favorites on a photo. 1. [Action][Action] - Comments and favorites on a photo.
1. [Tag][Tag] - Meta information for tags. 1. [Tag][Tag] - Meta information for tags.
---------------------------------------- ----------------------------------------
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown [User]: User.markdown
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown [Credential]: Credential.markdown
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown [Photo]: Photo.markdown
[Tag]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Tag.markdown [Action]: Action.markdown
[Tag]: Tag.markdown

6
documentation/schemas/User.markdown
View file

@ -27,6 +27,6 @@ This includes the last uploaded [Photo][Photo] and [Action][Action] id.
* lastPhotoId, most recent photo id * lastPhotoId, most recent photo id
* lastActionId, most recent action id * lastActionId, most recent action id
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown [User]: User.markdown
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown [Photo]: Photo.markdown
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown [Action]: Action.markdown