canmove, Confirmed users
737
edits
Jetpack/Porting to MDN: Difference between revisions
no edit summary
(Created page with "==What we're doing== At the moment the docs are stored as Markdown files (with some extra bits of HTML) in the same GitHub repo as the SDK code. We're going to move them from ...") |
No edit summary |
||
| Line 37: | Line 37: | ||
===Porting API reference docs=== | ===Porting API reference docs=== | ||
These are the docs that appear in the sidebar under "High-level APIs" and "Low level APIs". This is a bit more complicated because it's more structured information. I've written a guide specifically on that here: | These are the docs that appear in the sidebar under "High-level APIs" and "Low level APIs". This is a bit more complicated because it's more structured information. I've written a guide specifically on that here: [[Jetpack/SDK/Writing_Documentation|porting API pages]]. | ||
It's possible we will write some macros to help make sure these pages are all consistent. | |||
==Extra bits and pieces== | ==Extra bits and pieces== | ||
===Multi-page articles== | ===Multi-page articles=== | ||
For multi-page articles, I think we should stick the main page under https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials, then sub-pages under the main page. For example, for the Annotator we could have: https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Annotator containing https://addons.mozilla.org/en-US/developers/docs/sdk/Firefox-26/dev-guide/tutorials/annotator/index.html, then sub-pages like https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Annotator/Storing for each sub-page. | For multi-page articles, I think we should stick the main page under https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials, then sub-pages under the main page. For example, for the Annotator we could have: https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Annotator containing https://addons.mozilla.org/en-US/developers/docs/sdk/Firefox-26/dev-guide/tutorials/annotator/index.html, then sub-pages like https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Annotator/Storing for each sub-page. | ||
===Dealing with images== | ===Dealing with images=== | ||
For images: | For images: | ||
1) Find them in your SDK installation at doc/static-files/media/. | 1) Find them in your SDK installation at doc/static-files/media/. | ||