686598 - restore SDK 1.0 docs to AMO website

Status: VERIFIED FIXED

(Infrastructure & Operations Graveyard :: WebOps: Other, task)

Description

[Myk Melez [:myk] [@mykmelez]]

In the process of pushing the SDK 1.1 docs to the AMO website (bug 686341), the 1.0 docs were removed.  But we want them to remain available, so they should be restored to the site.

Will: can you provide instructions for restoring the docs?

Comment 1

[Jake Maul [:jakem]]

The process will basically be to check out the v1.0 version of the docs into a new dir, and then set up an Apache Alias that points to it... roughly similar to the 1.0 docs. This should be relatively straightforward, I think... I just don't know what to check out, and where it should go in the tree (side-by-side with the 1.0 ones, obviously, but I don't know if there's a naming convention to things in vendor/ or not).

Comment 2

[Will Bamberg [:wbamberg]]

The 1.0 version of the docs is in the addon-sdk-sdocs repo, tagged as 1.0rc4-amo: https://github.com/mozilla/addon-sdk-sdocs/tree/1.0rc4-amo.

Comment 3

[Wil Clouser [:clouserw]]

There is no convention.  My hope is that the docs go on MDN and we don't have to continue doing this (there is a bug for that) but in the mean time I'd make a directory called something reasonable (eg. /addons-sdk-docs-1.0/) and check out that ^^ tag into it.  Then I'd rename the current dir to /addons-sdk-docs-1.1/ and adjust the rewrites to point to the 1.1 dir.

Comment 4

[Jake Maul [:jakem]]

I have checked this out on dev and stage. I would like to at least verify the links seem to work there, although I understand the docs themselves are reliant on the www.mozilla.org hostname to work properly.


https://addons-dev.allizom.org/en-US/developers/docs/sdk/1.0/
https://addons-dev.allizom.org/en-US/developers/docs/sdk/1.1/
https://addons.allizom.org/en-US/developers/docs/sdk/1.0/
https://addons.allizom.org/en-US/developers/docs/sdk/1.0/

If someone could verify that these appear to be correct, that would be very handy. I'm assuming the broken stylesheets are to be expected, given the incorrect domain names... but I believe the content should be good. Please let me know so I can do prod.


Here's the basic procedure I'm using:

cd /data/addons-dev/src/<site>/zamboni/vendor/src
mv addon-sdk-sdocs addons-sdk-docs-1.1
mkdir addons-sdk-docs-1.0
cd addons-sdk-docs-1.0
git clone git://github.com/mozilla/addon-sdk-sdocs.git .
git checkout 1.0rc4-amo
cd ../../..
commander scripts/update/update.py deploy

Edit Apache config in puppet. Add the 1.0 line, update the 1.1 line to point to the proper place:
    Alias /en-US/developers/docs/sdk/1.0 /data/www/addons-dev.allizom.org/zamboni/vendor/src/addons-sdk-docs-1.0
    Alias /en-US/developers/docs/sdk/1.1 /data/www/addons-dev.allizom.org/zamboni/vendor/src/addons-sdk-docs-1.1

Comment 5

[Will Bamberg [:wbamberg]]

Hey Jake

Yes, they look all right to me. Thanks!

Comment 6

[Jake Maul [:jakem]]

This is completed on prod now as well:

https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/
https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/
https://addons.mozilla.org/en-US/developers/docs/sdk/latest/

It would be a good idea for someone to verify that they look correct (that is: that they're both the correct version), and that any external links we know of still work as expected. All 3 links "work", but I don't know what differences to look for to verify that each has the proper docs.

Comment 7

[Will Bamberg [:wbamberg]]

This also looks good. Thanks Jake.