658043 - Change /api to redirect to jetpack.mozillalabs documentation

Status: RESOLVED FIXED

(addons.mozilla.org Graveyard :: Add-on Builder, defect, P1)

Description

[Sean McArthur [:seanmonstar]]

We will no longer host the documentation, removing the burden of having up to date docs. We should continue to allow the /api link, only make it a 302 to whichever is the URL for the docs, whether its jetpack.mozillalabs.com, or MDN.

Comment 1

[Sean McArthur [:seanmonstar]]

The latest URL on the jetpack site does a blanket redirect to the the root of the docs, and drops any extra part of the path, so to allow deeplinking of the docks, we would need to update our settings to the real latest url. However,  this doesn't seem like much of an issue since we currently need to do a push with the new SDK version for every new version anyways.

@zalun: Also, our schema's a slightly different. In order to use generic redirect_to views, we would need to split api_page into api_package_page and api_module_page. Otherwise, we could skip using a generic, and make a single view split the url and handle the logic ourselves. I'm open to both.

FlightDeck       | Jetpack
/addon-kit       | /addon-kit/addon-kit.html
/addon-kit/panel | /addon-kit/docs/panel.html

Comment 2

[Sean McArthur [:seanmonstar]]

We'll just do this with Apache. However, it will also depend on Jetpack getting their rewrite to allow deeper linking.

Comment 3

[Sean McArthur [:seanmonstar]]

Do we do this with a .htaccess file, or provide the lines needed for the apache conf, or something else?

Comment 4

[Wil Clouser [:clouserw]]

either is fine (they're pretty much the same).  If we don't have a .htaccess already, it's easy to stick it in the vhost, we just need the regex

Comment 5

[Sean McArthur [:seanmonstar]]

in master https://github.com/seanmonstar/FlightDeck/commit/b8069c16a02de80dfe0f8f2044fa86d09b61941d

Will need in vhosts:

/docs/(.*)    https://jetpack.mozillalabs.com/sdk/latest/docs/$1

Comment 6

[Sean McArthur [:seanmonstar]]

With 661073 completed, this is done.