Normalizing and fixing links across pages in the documentation directory.
Gh-180
This commit is contained in:
Jaisen Mathai
parent
4ff958ae0c
commit
0f2b32d9e3
16 changed files with 48 additions and 50 deletions
|
|
@ -37,12 +37,12 @@ Every API endpoint returns a JSON response in a [standard envelope][Envelope].
|
|||
1. [POST /tag/:id/update.json][PostTag]
|
||||
Modify meta data for a user's tag.
|
||||
|
||||
[Envelope]: api/Envelope.markdown
|
||||
[GetHelloWorld]: api/GetHelloWorld.markdown
|
||||
[GetPhotos]: api/GetPhotos.markdown
|
||||
[GetPhoto]: api/GetPhoto.markdown
|
||||
[GetTags]: api/GetTags.markdown
|
||||
[PostPhotoUpload]: api/PostPhotoUpload.markdown
|
||||
[PostTag]: api/PostTag.markdown
|
||||
[authentication]: api/Authentication.markdown
|
||||
[Envelope]: Envelope.markdown
|
||||
[GetHelloWorld]: GetHelloWorld.markdown
|
||||
[GetPhotos]: GetPhotos.markdown
|
||||
[GetPhoto]: GetPhoto.markdown
|
||||
[GetTags]: GetTags.markdown
|
||||
[PostPhotoUpload]: PostPhotoUpload.markdown
|
||||
[PostTag]: PostTag.markdown
|
||||
[authentication]: Authentication.markdown
|
||||
[oauth1.0a]: http://oauth.net/core/1.0a/
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ The response is in a standard [response envelope][Envelope].
|
|||
}
|
||||
}
|
||||
|
||||
[Envelope]: api/Envelope.markdown
|
||||
[Envelope]: Envelope.markdown
|
||||
[purpose]: #purpose
|
||||
[endpoint]: #endpoint
|
||||
[parameters]: #parameters
|
||||
|
|
|
|||
|
|
@ -100,8 +100,8 @@ The response is in a standard [response envelope][Envelope].
|
|||
}
|
||||
}
|
||||
|
||||
[Envelope]: api/Envelope.markdown
|
||||
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown
|
||||
[Envelope]: Envelope.markdown
|
||||
[Photo]: ../schemas/Photo.markdown
|
||||
[purpose]: #purpose
|
||||
[endpoint]: #endpoint
|
||||
[parameters]: #parameters
|
||||
|
|
@ -110,5 +110,5 @@ The response is in a standard [response envelope][Envelope].
|
|||
[example-php]: #example-php
|
||||
[response]: #response
|
||||
[sample]: #sample
|
||||
[photogeneration]: faq/PhotoGeneration.markdown
|
||||
[ReturnSizes]: faq/ReturnSizes.markdown
|
||||
[photogeneration]: ../faq/PhotoGeneration.markdown
|
||||
[ReturnSizes]: ../faq/ReturnSizes.markdown
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ The response is in a standard [response envelope][Envelope].
|
|||
]
|
||||
}
|
||||
|
||||
[Envelope]: ../api/Envelope.markdown
|
||||
[Envelope]: Envelope.markdown
|
||||
[Photo]: ../schemas/Photo.markdown
|
||||
[purpose]: #purpose
|
||||
[endpoint]: #endpoint
|
||||
|
|
|
|||
|
|
@ -94,8 +94,8 @@ The response is in a standard [response envelope][Envelope].
|
|||
]
|
||||
}
|
||||
|
||||
[Envelope]: api/Envelope.markdown
|
||||
[Tag]: schemas/Tag.markdown
|
||||
[Envelope]: Envelope.markdown
|
||||
[Tag]: ../schemas/Tag.markdown
|
||||
[purpose]: #purpose
|
||||
[endpoint]: #endpoint
|
||||
[parameters]: #parameters
|
||||
|
|
|
|||
|
|
@ -123,8 +123,8 @@ The response is in a standard [response envelope][Envelope].
|
|||
}
|
||||
}
|
||||
|
||||
[Envelope]: api/Envelope.markdown
|
||||
[Photo]: schemas/Photo.markdown
|
||||
[Envelope]: Envelope.markdown
|
||||
[Photo]: ../schemas/Photo.markdown
|
||||
[purpose]: #purpose
|
||||
[endpoint]: #endpoint
|
||||
[parameters]: #parameters
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
||||
[guides]: guides/Readme.markdown
|
||||
[guides]: ../guides/Guides.markdown
|
||||
|
||||
|
|
|
|||
|
|
@ -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].
|
||||
|
||||
[GetPhotos]: api/GetPhotos.markdown
|
||||
[GetPhoto]: api/GetPhoto.markdown
|
||||
[ReturnSizes]: faq/ReturnSizes.markdown
|
||||
[GetPhotos]: ../api/GetPhotos.markdown
|
||||
[GetPhoto]: ../api/GetPhoto.markdown
|
||||
[ReturnSizes]: ../faq/ReturnSizes.markdown
|
||||
|
|
|
|||
|
|
@ -36,6 +36,6 @@ Adding `xCR` means that the photo will be exactly _200px_ by _200px_ and cropped
|
|||
### 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.
|
||||
|
||||
[GetPhoto]: api/GetPhoto.markdown
|
||||
[GetPhotos]: api/GetPhotos.markdown
|
||||
[photogeneration]: faq/PhotoGeneration.markdown
|
||||
[GetPhoto]: ../api/GetPhoto.markdown
|
||||
[GetPhotos]: ../api/GetPhotos.markdown
|
||||
[photogeneration]: ../faq/PhotoGeneration.markdown
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ OpenPhoto / Guides
|
|||
1. [Installation on Ubuntu with Cherokee][guideinstallubuntucherokee]
|
||||
1. [Installation via Amazon EC2 OpenPhoto AMI][guideinstallamazonec2]
|
||||
|
||||
[guideinstallubuntuapache]: guides/InstallationUbuntuApache.markdown
|
||||
[guideinstallosxmacports]: guides/InstallationOSXMacports.markdown
|
||||
[guideinstallsuse]: guides/InstallationSUSE.markdown
|
||||
[guideinstallubuntucherokee]: guides/InstallationUbuntuCherokee.markdown
|
||||
[guideinstallamazonec2]: guides/InstallationUsingOpenPhotoEC2-AMI.markdown
|
||||
[guideinstallubuntuapache]: InstallationUbuntuApache.markdown
|
||||
[guideinstallosxmacports]: InstallationOSXMacports.markdown
|
||||
[guideinstallsuse]: InstallationSUSE.markdown
|
||||
[guideinstallubuntucherokee]: InstallationUbuntuCherokee.markdown
|
||||
[guideinstallamazonec2]: InstallationUsingOpenPhotoEC2-AMI.markdown
|
||||
|
|
|
|||
|
|
@ -54,7 +54,3 @@ Verify the apache user has write access to the /home/ubuntu/openphoto/src/config
|
|||
ls -ld ./configs
|
||||
|
||||
drwxr-xr-x 3 www-data www-data 4096 2011-08-20 02:37 configs
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
||||
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown
|
||||
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown
|
||||
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown
|
||||
[User]: User.markdown
|
||||
[Photo]: Photo.markdown
|
||||
[Action]: Action.markdown
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ A Group consists of an `id`, `name` and array of `email addresses`.
|
|||
* name, the name of the group
|
||||
* members: a set of email addresses who belong to this group
|
||||
|
||||
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown
|
||||
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown
|
||||
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown
|
||||
[User]: User.markdown
|
||||
[Photo]: Photo.markdown
|
||||
[Action]: Action.markdown
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
* 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
|
||||
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown
|
||||
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown
|
||||
[User]: User.markdown
|
||||
[Photo]: Photo.markdown
|
||||
[Action]: Action.markdown
|
||||
|
|
|
|||
|
|
@ -23,13 +23,15 @@ Since a [Photo][Photo] object has a predictable set of properties it means that
|
|||
### Available schemas
|
||||
|
||||
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. [Action][Action] - Comments and favorites on a photo.
|
||||
1. [Tag][Tag] - Meta information for tags.
|
||||
|
||||
----------------------------------------
|
||||
|
||||
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown
|
||||
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown
|
||||
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown
|
||||
[Tag]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Tag.markdown
|
||||
[User]: User.markdown
|
||||
[Credential]: Credential.markdown
|
||||
[Photo]: Photo.markdown
|
||||
[Action]: Action.markdown
|
||||
[Tag]: Tag.markdown
|
||||
|
|
|
|||
|
|
@ -27,6 +27,6 @@ This includes the last uploaded [Photo][Photo] and [Action][Action] id.
|
|||
* lastPhotoId, most recent photo id
|
||||
* lastActionId, most recent action id
|
||||
|
||||
[User]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/User.markdown
|
||||
[Photo]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Photo.markdown
|
||||
[Action]: https://github.com/openphoto/frontend/blob/master/documentation/schemas/Action.markdown
|
||||
[User]: User.markdown
|
||||
[Photo]: Photo.markdown
|
||||
[Action]: Action.markdown
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue