Closed
Bug 686341
Opened 15 years ago
Closed 15 years ago
[AMO] Update SDK docs for 1.1
Categories
(Infrastructure & Operations Graveyard :: WebOps: Other, task)
Tracking
(Not tracked)
VERIFIED
FIXED
People
(Reporter: wbamberg, Unassigned)
Details
Please update the documentation for the SDK, for the SDK's 1.1 release. The documentation should be hosted at: https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/.
The repo to pull the docs from is https://github.com/mozilla/addon-sdk-sdocs, and the commit to use is tagged as 1.1rc1-amo. So to fetching the relevant documentation set should just be a matter of:
> git pull
> git checkout 1.1rc1-amo
The 1.1 release is tomorrow (Tuesday), and at that point https://addons.mozilla.org/en-US/developers/docs/sdk/latest/ should be updated to point to https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/ (I'm not sure whether we should have a separate bug for this, but it seems like overkill to me).
But I'd be very happy if the docs at https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/ could be updated today, then I could check that they look all right and fix any problems.
Comment 1•15 years ago
|
||
CCing jakem. I don't think there is anything for me to do here, but happy to help if there is. You can do -dev anytime so we can try things out.
Comment 2•15 years ago
|
||
Hmm... I think I found this, but there's a problem:
[root@addonsadm.private.phx1 addon-sdk-sdocs]# pwd
/data/addons-dev/src/addons-dev.allizom.org/zamboni/vendor/src/addon-sdk-sdocs
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git pull
You are not currently on a branch, so I cannot use any
'branch.<branchname>.merge' in your configuration file.
Please specify which remote branch you want to use on the command
line and try again (e.g. 'git pull <repository> <refspec>').
See git-pull(1) for details.
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git branch
* (no branch)
master
Not on a branch? I think I should be able to do 'git checkout master' to get on that branch, although I'm not sure how that will pan out... I can't do 'git checkout 1.1rc1-amo', though, even after 'git fetch'.
I do notice that github.com does not list a 1.1rc1-amo tag or branch. Unrelated to not being on a branch for the pull, but will probably affect the second step. :)
Also, this is part of the vendor subdirectory. I would have expected this to get updated during a normal push... is that not the case? Trying to wrap my head around how this works.
Comment 3•15 years ago
|
||
Looks like the right path. `git co master` should do you fine. Might do a `git status` in case there is anything fishy hanging around.
The 1.1rc1-amo tag missing is a problem though. Will - if you made a branch it doesn't look like you pushed it to github. I can help tomorrow if you're not sure about it. You committed code to trunk, fwiw, just not a tag.
| Reporter | ||
Comment 4•15 years ago
|
||
Sorry. There is only the one branch, master, and the head revision would work fine, but I didn't push the tag for it. It's done now: https://github.com/mozilla/addon-sdk-sdocs/tree/1.1rc1-amo.
Comment 5•15 years ago
|
||
Okay, some progress here. Are we okay to leave this on 'master'? "git checkout 1.1rc1-amo" results in a detached HEAD state, so I left it on master.
This is all on addons-dev.allizom.org, by the way. Let me know if it looks okay and we can do stage and prod.
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git checkout master
Previous HEAD position was ad7d8a3... added RC4 sdocs
Switched to branch 'master'
Your branch is behind 'origin/master' by 3 commits, and can be fast-forwarded.
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git branch
* master
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git status
# On branch master
# Your branch is behind 'origin/master' by 3 commits, and can be fast-forwarded.
#
nothing to commit (working directory clean)
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git fetch
remote: Counting objects: 1, done.
remote: Total 1 (delta 0), reused 1 (delta 0)
Unpacking objects: 100% (1/1), done.
From git://github.com/mozilla/addon-sdk-sdocs
* [new tag] 1.1rc1-amo -> 1.1rc1-amo
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git pull
Updating 1f8641b..595a8b9
Fast-forward
README.md | 1 -
base.html | 10 +
dev-guide/addon-development/about.html | 16 +-
.../addon-development/annotator/annotator.html | 16 +-
.../addon-development/annotator/creating.html | 16 +-
.../addon-development/annotator/displaying.html | 16 +-
.../addon-development/annotator/overview.html | 16 +-
dev-guide/addon-development/annotator/storing.html | 16 +-
dev-guide/addon-development/annotator/widget.html | 16 +-
dev-guide/addon-development/api-idioms.html | 16 +-
dev-guide/addon-development/api-intro.html | 16 +-
dev-guide/addon-development/api-modules.html | 21 +-
dev-guide/addon-development/cfx-tool.html | 16 +-
dev-guide/addon-development/commonjs.html | 31 +-
dev-guide/addon-development/console.html | 16 +-
dev-guide/addon-development/events.html | 16 +-
dev-guide/addon-development/getting-started.html | 16 +-
dev-guide/addon-development/guides.html | 16 +-
.../implementing-reusable-module.html | 16 +-
.../implementing-simple-addon.html | 18 +-
dev-guide/addon-development/installation.html | 84 ++-
dev-guide/addon-development/module-search.html | 16 +-
dev-guide/addon-development/package-spec.html | 32 +-
dev-guide/addon-development/program-id.html | 16 +-
dev-guide/addon-development/reference.html | 16 +-
dev-guide/addon-development/troubleshooting.html | 16 +-
dev-guide/addon-development/tutorials.html | 16 +-
.../addon-development/two-types-of-scripts.html | 16 +-
dev-guide/addon-development/web-content.html | 19 +-
dev-guide/appendices/credits.html | 20 +-
dev-guide/appendices/glossary.html | 23 +-
dev-guide/module-development/about.html | 16 +-
dev-guide/module-development/best-practices.html | 32 +-
dev-guide/module-development/chrome.html | 16 +-
dev-guide/module-development/e10s.html | 16 +-
dev-guide/module-development/globals.html | 16 +-
dev-guide/module-development/guides.html | 16 +-
dev-guide/module-development/reference.html | 16 +-
dev-guide/module-development/tutorials.html | 16 +-
dev-guide/module-development/xpi.html | 20 +-
dev-guide/welcome.html | 16 +-
index.html | 16 +-
js/main.js | 3 +-
md/dev-guide/addon-development/api-modules.md | 4 +
md/dev-guide/addon-development/commonjs.md | 16 +-
.../addon-development/implementing-simple-addon.md | 2 +-
md/dev-guide/addon-development/installation.md | 77 ++-
md/dev-guide/addon-development/package-spec.md | 16 +-
md/dev-guide/addon-development/web-content.md | 3 +
md/dev-guide/appendices/credits.md | 4 +-
md/dev-guide/appendices/glossary.md | 7 +-
md/dev-guide/module-development/best-practices.md | 16 +-
md/dev-guide/module-development/xpi.md | 4 +-
media/screenshots/widget-panel-clock.png | Bin 0 -> 60823 bytes
packages/addon-kit/addon-kit.html | 22 +-
packages/addon-kit/docs/clipboard.html | 16 +-
packages/addon-kit/docs/context-menu.html | 331 +++++++---
packages/addon-kit/docs/context-menu.md | 304 ++++++---
packages/addon-kit/docs/context-menu.md.div | 315 +++++++---
packages/addon-kit/docs/context-menu.md.json | 2 +-
packages/addon-kit/docs/hotkeys.html | 16 +-
packages/addon-kit/docs/notifications.html | 16 +-
packages/addon-kit/docs/page-mod.html | 42 +-
packages/addon-kit/docs/page-mod.md | 30 +-
packages/addon-kit/docs/page-mod.md.div | 26 +-
packages/addon-kit/docs/page-mod.md.json | 2 +-
packages/addon-kit/docs/page-worker.html | 16 +-
packages/addon-kit/docs/panel.html | 16 +-
packages/addon-kit/docs/passwords.html | 16 +-
packages/addon-kit/docs/private-browsing.html | 16 +-
packages/addon-kit/docs/request.html | 16 +-
packages/addon-kit/docs/selection.html | 16 +-
packages/addon-kit/docs/self.html | 25 +-
packages/addon-kit/docs/self.md | 12 +-
packages/addon-kit/docs/self.md.div | 9 +-
packages/addon-kit/docs/self.md.json | 2 +-
packages/addon-kit/docs/simple-storage.html | 16 +-
packages/addon-kit/docs/tabs.html | 47 +-
packages/addon-kit/docs/tabs.md | 36 +-
packages/addon-kit/docs/tabs.md.div | 31 +-
packages/addon-kit/docs/tabs.md.json | 2 +-
packages/addon-kit/docs/timers.html | 16 +-
packages/addon-kit/docs/widget.html | 88 +++-
packages/addon-kit/docs/widget.md | 79 +++
packages/addon-kit/docs/widget.md.div | 72 ++
packages/addon-kit/docs/widget.md.json | 2 +-
packages/addon-kit/docs/windows.html | 16 +-
packages/api-utils/README.md | 6 +-
packages/api-utils/api-utils.html | 24 +-
packages/api-utils/docs/api-utils.html | 16 +-
packages/api-utils/docs/app-strings.html | 16 +-
packages/api-utils/docs/byte-streams.html | 16 +-
packages/api-utils/docs/collection.html | 16 +-
packages/api-utils/docs/content.html | 16 +-
packages/api-utils/docs/content/loader.html | 16 +-
packages/api-utils/docs/content/proxy.html | 710 ++++++++++++++++++++
packages/api-utils/docs/content/proxy.md | 237 +++++++
packages/api-utils/docs/content/proxy.md.div | 253 +++++++
packages/api-utils/docs/content/proxy.md.json | 1 +
packages/api-utils/docs/content/symbiont.html | 16 +-
packages/api-utils/docs/content/worker.html | 16 +-
packages/api-utils/docs/cortex.html | 16 +-
packages/api-utils/docs/cuddlefish.html | 16 +-
packages/api-utils/docs/e10s.html | 16 +-
packages/api-utils/docs/errors.html | 16 +-
packages/api-utils/docs/es5.html | 16 +-
packages/api-utils/docs/events.html | 16 +-
packages/api-utils/docs/file.html | 16 +-
packages/api-utils/docs/hidden-frame.html | 16 +-
packages/api-utils/docs/light-traits.html | 16 +-
packages/api-utils/docs/list.html | 16 +-
packages/api-utils/docs/match-pattern.html | 16 +-
packages/api-utils/docs/memory.html | 16 +-
packages/api-utils/docs/observer-service.html | 16 +-
packages/api-utils/docs/plain-text-console.html | 16 +-
packages/api-utils/docs/preferences-service.html | 16 +-
packages/api-utils/docs/securable-module.html | 16 +-
packages/api-utils/docs/tab-browser.html | 16 +-
packages/api-utils/docs/text-streams.html | 16 +-
packages/api-utils/docs/traceback.html | 16 +-
packages/api-utils/docs/traits.html | 16 +-
packages/api-utils/docs/unit-test.html | 16 +-
packages/api-utils/docs/unload.html | 16 +-
packages/api-utils/docs/url.html | 16 +-
packages/api-utils/docs/window-utils.html | 29 +-
packages/api-utils/docs/window-utils.md | 7 +
packages/api-utils/docs/window-utils.md.div | 13 +
packages/api-utils/docs/window-utils.md.json | 2 +-
packages/api-utils/docs/xhr.html | 18 +-
packages/api-utils/docs/xhr.md | 2 +-
packages/api-utils/docs/xhr.md.div | 2 +-
packages/api-utils/docs/xhr.md.json | 2 +-
packages/api-utils/docs/xpcom.html | 16 +-
packages/api-utils/docs/xul-app.html | 16 +-
packages/development-mode/README.md | 2 +-
packages/development-mode/development-mode.html | 20 +-
packages/development-mode/docs/bootstrap.html | 16 +-
packages/development-mode/docs/main.html | 16 +-
packages/index.json | 2 +-
packages/test-harness/docs/harness.html | 16 +-
packages/test-harness/docs/run-tests.html | 16 +-
packages/test-harness/test-harness.html | 18 +-
142 files changed, 4021 insertions(+), 533 deletions(-)
delete mode 100644 README.md
create mode 100755 media/screenshots/widget-panel-clock.png
create mode 100644 packages/api-utils/docs/content/proxy.html
create mode 100644 packages/api-utils/docs/content/proxy.md
create mode 100644 packages/api-utils/docs/content/proxy.md.div
create mode 100644 packages/api-utils/docs/content/proxy.md.json
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git checkout 1.1rc1-amo
Note: checking out '1.1rc1-amo'.
You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.
If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:
git checkout -b new_branch_name
HEAD is now at 595a8b9... Added 1.1 docset from release candidate 1
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git branch
* (no branch)
master
[root@addonsadm.private.phx1 addon-sdk-sdocs]# git checkout master
Switched to branch 'master'
| Reporter | ||
Comment 6•15 years ago
|
||
(In reply to Jake Maul [:jakem] from comment #5)
> Okay, some progress here. Are we okay to leave this on 'master'? "git
> checkout 1.1rc1-amo" results in a detached HEAD state, so I left it on
> master.
>
That ought to be fine.
> This is all on addons-dev.allizom.org, by the way. Let me know if it looks
> okay and we can do stage and prod.
>
Could you push to addons.mozilla.org, and I can check it there? The internal paths expect addons.mozilla.org, and won't work with a different host :-(.
Comment 7•15 years ago
|
||
This has been completed on stage and prod, on the admin node. However, for those to go live I will most likely need to trigger a deploy job. Okay to do this clouserw?
| Reporter | ||
Comment 8•15 years ago
|
||
(In reply to Jake Maul [:jakem] from comment #7)
> This has been completed on stage and prod, on the admin node. However, for
> those to go live I will most likely need to trigger a deploy job. Okay to do
> this clouserw?
Is there any particular login I need to see the docs at https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/?
Thanks!
Comment 9•15 years ago
|
||
(In reply to Will Bamberg [:wbamberg] from comment #6)
> (In reply to Jake Maul [:jakem] from comment #5)
> > Okay, some progress here. Are we okay to leave this on 'master'? "git
> > checkout 1.1rc1-amo" results in a detached HEAD state, so I left it on
> > master.
> >
>
> That ought to be fine.
Detached HEAD doesn't matter, but neither does being on master. Whatever.
> This has been completed on stage and prod, on the admin node. However, for
> those to go live I will most likely need to trigger a deploy job. Okay to do
> this clouserw?
Sure, only thing going out is the docs so it should be fine.
> Is there any particular login I need to see the docs at
> https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/?
That needs a login because it's a 404 page. The /1.1/ rewrite needs to be done still.
Comment 10•15 years ago
|
||
13:57:32 - canuckistani: bkero: doesn't seem to work: https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/
13:59:28 - bkero: canuckistani: hrm, I'm not sure what I'll need to do to deploy it then. I ran the manual deployment commander script
14:00:47 - myk: bkero: ok, thanks anyway; i'll post that in the bug, and we'll see what wbamberg and clouserw have to say
Comment 11•15 years ago
|
||
myk, that link doesn't work per clouserw's comment 9.
clouserw, is there a separate bug for that redirect? I have no info on that... not sure what is needed.
Comment 12•15 years ago
|
||
clouserw indicated previously that the 1.1 docs had been pushed, but a redirect needed to be done. I guess we have a gap wrt to what final step is required?
Comment 13•15 years ago
|
||
Looked into this a bit more, the docs seem to be partly deployed:
1. the main page works:
https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/
2. some number of pages work but have no styling:
https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/dev-guide/addon-development/guides.html
3. all of the links on the second link above seem to have SDK 1.1 links, such as:
https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/dev-guide/addon-development/web-content.html
4. none of the 1.1 links work, they redirect to login.
Comment 14•15 years ago
|
||
Hmm, is it possible that the docs got pushed to https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/ instead of https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/ ?
Comment 15•15 years ago
|
||
As Will notes on IRC: https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/dev-guide/addon-development/installation.html is clearly the 1.1 version, and its <base> tag is <base href="https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/" >, but because there are no files under https://addons.mozilla.org/en-US/developers/docs/sdk/1.1/, then it does not find any CSS or JS.
Comment 16•15 years ago
|
||
This should now all be working properly.
The rewrites clouserw was referring to are actually already in the apache config, and just needed bumped from 1.0 to 1.1. It's actually a redirect and an alias, working in concert:
Redirect /en-US/developers/docs/sdk/latest https://addons.mozilla.org/en-US/developers/docs/sdk/1.1
Alias /en-US/developers/docs/sdk/1.1 /data/www/addons.mozilla.org/zamboni/vendor/src/addon-sdk-sdocs
This has been pushed out to the web heads, and the 1.1 docs should be operational.
One issue with this is that the 1.0 docs are no longer accessible- they're not on the servers at all, and the alias to them is gone. If necessary, we can work on getting them back online. I'll need to know what git commands to run to pull the proper content, but otherwise it shouldn't be *too* hard. How you'd actually link to it other than just having the 1.0 links bookmarked is another problem entirely...
Please let me know if you have any problems with this.
Status: NEW → RESOLVED
Closed: 15 years ago
Resolution: --- → FIXED
Comment 17•15 years ago
|
||
(In reply to Jake Maul [:jakem] from comment #16)
> This has been pushed out to the web heads, and the 1.1 docs should be
> operational.
It looks like the 1.1 docs and the "latest" redirect are both working fine. Thanks Jake!
> One issue with this is that the 1.0 docs are no longer accessible- they're
> not on the servers at all, and the alias to them is gone. If necessary, we
> can work on getting them back online. I'll need to know what git commands to
> run to pull the proper content, but otherwise it shouldn't be *too* hard.
We do want to keep the 1.0 docs available, linking to them as appropriate (f.e. from the Jetpack section of wikimo), so I have filed bug 686598 on restoring them.
Status: RESOLVED → VERIFIED
Updated•13 years ago
|
Component: Server Operations: Web Operations → WebOps: Other
Product: mozilla.org → Infrastructure & Operations
Updated•7 years ago
|
Product: Infrastructure & Operations → Infrastructure & Operations Graveyard
You need to log in
before you can comment on or make changes to this bug.
Description
•