Document extension and app types

Document extension and app types

R=rdevlin.cronin@chromium.org,benwells@chromium.org
BUG=none

Review-Url: https://codereview.chromium.org/2699553002
Cr-Commit-Position: refs/heads/master@{#453439}
Committed: https://chromium.googlesource.com/chromium/src/+/4041a2c69ea6849c3a7d7aee2079b24da0cb0c3f

[michaelpg, 2017-02-14 23:26:26]

Extensions docs! Could you let me know what parts of this are incorrect or
unclear?

[Rahul Chaturvedi, 2017-02-17 22:28:55]

steel@chromium.org changed reviewers:
+ steel@chromium.org

[Rahul Chaturvedi, 2017-02-17 22:28:56]

lgtm

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
File extensions/docs/extension_and_app_types.md (right):

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:60: shelf" or Chrome OS) in the
Chrome menu when visiting a web page or an extension
s/or/on

[benwells, 2017-02-20 23:57:02]

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
File extensions/docs/extension_and_app_types.md (right):

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:37: bluetooth, hid, and usb devices.
Might want to add that these are deprecated on all platforms except ChromeOS.

I just saw in the .png there is a "Deprecated on desktop." Could you say
"Deprecated on non-ChromeOS platforms" instead?

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:60: shelf" or Chrome OS) in the
Chrome menu when visiting a web page or an extension
On 2017/02/17 22:28:55, Rahul Chaturvedi wrote:
> s/or/on

I think it is as it is?

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:72: This kind of app is technically a
hosted app.
This is true but there are some little differences. Maybe say "This kind of app
is implemented as a special type of hosted app." ??

[benwells, 2017-02-20 23:57:29]

On 2017/02/20 23:57:02, benwells wrote:
>
https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
> File extensions/docs/extension_and_app_types.md (right):
> 
>
https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
> extensions/docs/extension_and_app_types.md:37: bluetooth, hid, and usb
devices.
> Might want to add that these are deprecated on all platforms except ChromeOS.
> 
> I just saw in the .png there is a "Deprecated on desktop." Could you say
> "Deprecated on non-ChromeOS platforms" instead?
> 
>
https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
> extensions/docs/extension_and_app_types.md:60: shelf" or Chrome OS) in the
> Chrome menu when visiting a web page or an extension
> On 2017/02/17 22:28:55, Rahul Chaturvedi wrote:
> > s/or/on
> 
> I think it is as it is?

Oops, lol, I means "I think it is correct as it is"

> 
>
https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
> extensions/docs/extension_and_app_types.md:72: This kind of app is technically
a
> hosted app.
> This is true but there are some little differences. Maybe say "This kind of
app
> is implemented as a special type of hosted app." ??

[Devlin, 2017-02-21 14:05:10]

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
File extensions/docs/extension_and_app_types.md (right):

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:20: * downloads
This list is very inexhaustive.  I wonder if we should instead concentrate on
the more fundamental aspects?  I usually consider an extension "something that
can alter my browsing experience through interaction with either the web content
or the browser itself."

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:22: `Extension` is also the class
type for all extensions and apps, so technically
This is pretty nitty-gritty, and is really a code implementation detail.  Do we
really want it here?  At the very least, I'd put it in a separate section. 
Conceptually, they are very different.

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:25: 
Do we want to document shared modules or converted user scripts?

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:30: Platform apps (*v2 packaged
apps*) have `app.background.page` and/or
Here, too, I'd start with something more fundamental - what is a platform app?

Something along the lines of "an isolated application that runs independently of
the browser", and maybe give some canonical examples (e.g. calculator).

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:53: permissions. Chrome ask for these
permissions during the app's installation,
Should we mention Chrome?

(also, typo, *asks)

[michaelpg, 2017-02-21 23:50:40]

Thanks all. I've reworded the doc to focus more on the big picture and moved or
removed the more technical stuff (there should still be enough here to put code
spelunkers on the right track)

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
File extensions/docs/extension_and_app_types.md (right):

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:20: * downloads
On 2017/02/21 14:05:10, Devlin wrote:
> This list is very inexhaustive.  I wonder if we should instead concentrate on
> the more fundamental aspects?  I usually consider an extension "something that
> can alter my browsing experience through interaction with either the web
content
> or the browser itself."

Shortened to be less specific.

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:22: `Extension` is also the class
type for all extensions and apps, so technically
On 2017/02/21 14:05:10, Devlin wrote:
> This is pretty nitty-gritty, and is really a code implementation detail.  Do
we
> really want it here?  At the very least, I'd put it in a separate section. 
> Conceptually, they are very different.

yeah, i've moved this to the end.

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:25: 
On 2017/02/21 14:05:10, Devlin wrote:
> Do we want to document shared modules or converted user scripts?

Feel free! (I didn't even know about converted user scripts...)

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:30: Platform apps (*v2 packaged
apps*) have `app.background.page` and/or
On 2017/02/21 14:05:10, Devlin wrote:
> Here, too, I'd start with something more fundamental - what is a platform app?
> 
> Something along the lines of "an isolated application that runs independently
of
> the browser", and maybe give some canonical examples (e.g. calculator).

Done.

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:37: bluetooth, hid, and usb devices.
On 2017/02/20 23:57:02, benwells wrote:
> Might want to add that these are deprecated on all platforms except ChromeOS.

Doh, yes indeed.

> 
> I just saw in the .png there is a "Deprecated on desktop." Could you say
> "Deprecated on non-ChromeOS platforms" instead?

Done.

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:53: permissions. Chrome ask for these
permissions during the app's installation,
On 2017/02/21 14:05:10, Devlin wrote:
> Should we mention Chrome?

As opposed to "the browser" or something? (IIRC, Chrome is the product name as
far as documentation and descriptions are concerned, even in the Chromium
project.)

> 
> (also, typo, *asks)

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:60: shelf" or Chrome OS) in the
Chrome menu when visiting a web page or an extension
On 2017/02/20 23:57:02, benwells wrote:
> On 2017/02/17 22:28:55, Rahul Chaturvedi wrote:
> > s/or/on
> 
> I think it is as it is?

The first "or" should be "on".

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:60: shelf" or Chrome OS) in the
Chrome menu when visiting a web page or an extension
On 2017/02/17 22:28:55, Rahul Chaturvedi wrote:
> s/or/on

Done.

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:72: This kind of app is technically a
hosted app.
On 2017/02/20 23:57:02, benwells wrote:
> This is true but there are some little differences. Maybe say "This kind of
app
> is implemented as a special type of hosted app." ??

Reworked into the opening paragraph.

[benwells, 2017-02-22 06:46:49]

lgtm. Thanks for documenting things!

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
File extensions/docs/extension_and_app_types.md (right):

https://codereview.chromium.org/2699553002/diff/1/extensions/docs/extension_a...
extensions/docs/extension_and_app_types.md:60: shelf" or Chrome OS) in the
Chrome menu when visiting a web page or an extension
On 2017/02/21 23:50:39, michaelpg wrote:
> On 2017/02/20 23:57:02, benwells wrote:
> > On 2017/02/17 22:28:55, Rahul Chaturvedi wrote:
> > > s/or/on
> > 
> > I think it is as it is?
> 
> The first "or" should be "on".

Doh!

[Devlin, 2017-02-27 23:48:48]

lgtm

[michaelpg, 2017-02-28 01:20:54]

The CQ bit was checked by michaelpg@chromium.org

[michaelpg, 2017-02-28 01:20:55]

The patchset sent to the CQ was uploaded after l-g-t-m from steel@chromium.org
Link to the patchset: https://codereview.chromium.org/2699553002/#ps40001
(title: "minor reword")

[commit-bot: I haz the power, 2017-02-28 01:21:24]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-02-28 01:35:17]

CQ is committing da patch.

Bot data: {"patchset_id": 40001, "attempt_start_ts": 1488244854775510,
"parent_rev": "f3a0c5efb1b206e15b7c2dfcca8212612cbb83be", "commit_rev":
"4041a2c69ea6849c3a7d7aee2079b24da0cb0c3f"}

[commit-bot: I haz the power, 2017-02-28 01:36:22]

Description was changed from

==========
Document extension and app types

R=rdevlin.cronin@chromium.org,benwells@chromium.org
BUG=none
==========

to

==========
Document extension and app types

R=rdevlin.cronin@chromium.org,benwells@chromium.org
BUG=none

Review-Url: https://codereview.chromium.org/2699553002
Cr-Commit-Position: refs/heads/master@{#453439}
Committed:
https://chromium.googlesource.com/chromium/src/+/4041a2c69ea6849c3a7d7aee2079...
==========

[commit-bot: I haz the power, 2017-02-28 01:36:23]

Committed patchset #3 (id:40001) as
https://chromium.googlesource.com/chromium/src/+/4041a2c69ea6849c3a7d7aee2079...