From:  William Bamberg <wbamberg@mozilla.com>
Date:  15 May 2017 23:59:03 Hong Kong Time
Newsgroup:  news.mozilla.org/mozilla.dev.mdc
Subject:  

Re: Representing secure context API features on MDN

NNTP-Posting-Host:  63.245.214.181

I'm not very keen on having more boilerplate banners across the tops of
pages. Although we did get rid of the "needs review" ones, we still have
quite a few, and it's easy to get into a situation where there's a big pile
of boilerplate-text banners across the pages, which is a bad experience IMO.

I see the text in the proposed banner is:

"This feature is available only in [secure contexts], in some or all supporting browsers"

As a reader, I'd then expect that the '#Browser_compatibility' would give
me the details on which browsers this applies to. Is the idea then that the
browser compat data will give me the details here? And if that's the case,
then (1) should we update the schema to be able to represent this
information?

Personally, I think we should
(1) add this to the BCD schema
(2) not add a banner for this, but just include it in the compat tables.
People need to use the compat tables anyway to answer the question "can I
use this feature".

>> a. Break out the list to a separate page that lists all the features
available only in secure contexts, in the same way that we do for web
workers [2]

If you use compat data, you can generate this page.

Will



On Mon, May 15, 2017 at 4:53 AM, Chris Mills  wrote:

>
> > On 11 May 2017, at 13:19, Eric Shepherd (Sheppy) 
> wrote:
> >
> > On May 10, 2017, at 4:13 PM, Chris Mills  wrote:
> >>
> >> a. Break out the list to a separate page that lists all the features
> available only in secure contexts, in the same way that we do for web
> workers [2]
> >
> > Yes, I agree with that.
>
> OK, done!
>
> https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts
> https://developer.mozilla.org/en-US/docs/Web/Security/
> Secure_Contexts/features_restricted_to_secure_contexts
>
> >
> >> b. Create macros to display a block banner/header, and an inline
> ribbon/tag stating that a feature is available only in secure context.
> >
> > Yeah. I’d say we need a badge-y thing, like a lock icon, for these, to
> use in sidebars and lists and such, plus a macro that creates an
> appropriate head banner. We may also want a class for a “secure context
> only” box, similar to the note or warning boxes, for explaining small bits
> of secure context information in a otherwise general article.
>
> I have submitted a basic PR for a set of macros to create the block
> banner/inline tag:
>
> https://github.com/mozilla/kumascript/pull/179
>
> I am also going to talk to the devs about the custom styling aspects.
>
> >
> >>
> >> Any opinions or concerns here? Do we already have this stuff, and I’ve
> just not found it yet? ;-)
> >
> > We also should come up with a tag to use for articles about stuff only
> available in secure contexts.
>
> Yes, true. I’d vote for simply “Secure contexts” — does anyone have a
> problem with that?
>
> This would also help us update the sidebar macros at a later date so they
> can display the secure context icon next to relevant features. When we
> decide on the icon, of course.
> _________________________________________________________________________
> Discussing Developer documentation on MDN: dev-mdc mailing list
> List email: dev-mdc@lists.mozilla.org
> Manage your membership: https://lists.mozilla.org/listinfo/dev-mdc
> Unsubscribe: https://lists.mozilla.org/options/dev-mdc/wbamberg%
> 40mozilla.com?unsub=1&unsubconfirm=1
> MDN contributor guide: http://bit.ly/ContributorGuide
>