844931 - Fix documentation on devhub/MDN

Status: RESOLVED DUPLICATE of bug 846514

(Marketplace Graveyard :: Developer Pages, defect)

Description

[Matt Basta [:basta]]

- All CSP-related docs should point to d.m.o/docs/Apps/CSP. All other documentation regarding the CSP is not apps-specific and is likely out-of-date (much of the documentation is pre-w3c spec)
- m.f.c/developers/docs/quick_start has comments in the JSON under the "WebRT APIs" section. This is syntactically incorrect.
- H2 and H3 elements in devhub documentation are visually identical. http://cl.ly/image/3P1o0A0Q1U1M
- The "simple manifest" on the quick start page has a "permissions" field but does not specify `"type": "privileged"`. This is invalid.
- Lots of whitespace (too much whitespace?) before and after <pre> elements.
- <a>s inside H* elements have no additional styling http://cl.ly/image/3Z3r342C2C0E
- Stray "'" on m.f.c/developers/docs/manifests under the first bullet.
- "Firefox OS Marketplace" is not the name of the marketplace. All instances of it should be changed to "Firefox Marketplace". There are a few instances of this on m.f.c/developers/docs/manifests and m.f.c/developers/docs/review
- The "Note" under "Why not just upload the..." on the above page is no longer valid and should be removed. http://cl.ly/image/1O0I2u3v0J1H
- The last FAQ on the above page should have a link to the support page.

I have no idea which place is the "source of truth" for documentation and I'd rather not fix an issue on MDN only to have it overwritten (or vise versa). If someone can fill me in on where these changes should live/be written/be copied, I can take a stab at some of these.

Comment 1

[Fred Wenzel [:wenzel]]

dbuc, can you help dissect this?

Comment 2

[Matt Basta [:basta]]

Bumping the importance of this because the docs contain critical inaccuracies, not just minor issues.

Comment 3

[havi hoffman [:havi]]

some small copyedit/comment things:

1. https://marketplace-dev.allizom.org/developers/docs/quick_start

Packed apps are essentially a zip file --->
Packaged apps are essentially a zip file 

you can make the decision to bundle as a packed app or launch as a hosted app.-->
you can make the decision to bundle as a packaged app or launch as a hosted app.

2. Question about the Treehouse video embeds - after the video is played the viewer is shown a 'promo' screen for Treehouse and Treehouse channel with links off to various Treehouse videos that have nothing to do w/Firefox OS or Apps. Was that part of our deal w/Treehouse when they made these? Or is there a way to tweak the Youtube embed code or use a different video hosting solution (vidly?) to avoid this ? It just looks weirdly commercial sitting in the body of text...

Comment 4

[Daniel Buchner [:dbuc]]

> 2. Question about the Treehouse video embeds - after the video is played the
> viewer is shown a 'promo' screen for Treehouse and Treehouse channel with
> links off to various Treehouse videos that have nothing to do w/Firefox OS
> or Apps. Was that part of our deal w/Treehouse when they made these? Or is
> there a way to tweak the Youtube embed code or use a different video hosting
> solution (vidly?) to avoid this ? It just looks weirdly commercial sitting
> in the body of text...

Yes, this was part of our agreement for them generously working on generating FFOS/app specific content for us. We will be branching out and doing more service/tool deals with community-friendly companies in the coming quarter.

Comment 5

[Fred Wenzel [:wenzel]]

Okay I filed followup bugs for all these that I hope are logically consistent.

The only one I didn't file yet is this one:

(In reply to Matt Basta [:basta] from comment #0)
> - All CSP-related docs should point to d.m.o/docs/Apps/CSP. All other
> documentation regarding the CSP is not apps-specific and is likely
> out-of-date (much of the documentation is pre-w3c spec)

Looks like an MDN content bug? I could file there, but not sure what the right place it. Any idea?

Comment 6

[Mark Giffin [:markg]]

(In reply to Fred Wenzel [:wenzel] from comment #5)
> 
> The only one I didn't file yet is this one:
> 
> (In reply to Matt Basta [:basta] from comment #0)
> > - All CSP-related docs should point to d.m.o/docs/Apps/CSP. All other
> > documentation regarding the CSP is not apps-specific and is likely
> > out-of-date (much of the documentation is pre-w3c spec)
> 
> Looks like an MDN content bug? I could file there, but not sure what the
> right place it. Any idea?

Try this for an MDN bug:

https://bugzilla.mozilla.org/form.mdn