W3C home > Mailing lists > Public > public-webplatform@w3.org > May 2014

Re: new plan to replace flags with Readiness Markers

From: Doug Schepers <schepers@w3.org>
Date: Sun, 11 May 2014 22:25:01 -0400
Message-ID: <537030FD.4000502@w3.org>
To: Amelia Bellamy-Royds <amelia.bellamy.royds@gmail.com>
CC: Eliot Graff <Eliot.Graff@microsoft.com>, List WebPlatform public <public-webplatform@w3.org>
+1 to short and sweet.

I think people are scared away by the big banners.

As for the rest of it, great work, Amelia!

Regards-
-Doug

On 5/11/14 2:22 PM, Amelia Bellamy-Royds wrote:
> Thanks for the feedback Eliot.  I'm definitely okay with switching to a
> short and sweet approach if people want to get away from having big site
> metadata blocks at the top of each page.
>
> Your idea of putting the extra content, invitation to edit etc., into
> the state definition page would provide another way to make the
> connection between "this isn't done" and "please help finish it!".
>
> As far as I know, the only written definitions are the sample ones I
> drafted for the property page:
> http://docs.webplatform.org/test/Property:State
>
> However, if we're going to put a lot of content in there with the
> definitions it might be worth creating a separate page in the WPD
> namespace, effectively replacing the current FAQs about "What does alpha
> mean?"
>
> ...Amelia
>
>
>
> On 11 May 2014 12:00, Eliot Graff <Eliot.Graff@microsoft.com
> <mailto:Eliot.Graff@microsoft.com>> wrote:
>
>     Hi Amelia.____
>
>     __ __
>
>     Thanks so much for undertaking this. When this is done the site will
>     look a ton cleaner.____
>
>     __ __
>
>     To me, the crucial information is this first sentence, and I think
>     the ultimate solution is to just call this out:____
>
>     __ __
>
>     */This article is Almost Done/*/____/
>
>     __ __
>
>     If we make the term a link to the page with the definitions, we’ll
>     satisfy the requirements for this feature:____
>
>     __ __
>
>     */This article is /**/Almost Done/*
>     <http://URL_for_page_with_defintions>____
>
>     __ __
>
>     The target page can have the definitions plus any other information
>     we want to add about editing resources, joining community, etc.____
>
>     __ __
>
>     Sorry if I am forgetting, but do we have a wiki or page entry with
>     drafts for the definitions of the readiness states? I remember
>     talking about it, but I can’t find a link to anything. If we do, I
>     am happy to chime in there.____
>
>     __ __
>
>     Again, thank you so much for driving this forward.____
>
>     __ __
>
>     Eliot____
>
>     __ __
>
>     *From:*Amelia Bellamy-Royds [mailto:amelia.bellamy.royds@gmail.com
>     <mailto:amelia.bellamy.royds@gmail.com>]
>     *Sent:* Saturday, May 10, 2014 10:32 PM
>     *To:* Eliezer Bernart; Jen Simmons
>     *Cc:* List WebPlatform public
>     *Subject:* Re: new plan to replace flags with Readiness Markers____
>
>     __ __
>
>     This has been put on the back-burner for a couple weeks, but I've
>     got a bare-bones mock-up ready-to-go on the test wiki that I think
>     meets all the goals that have been discussed.____
>
>     __ __
>
>     If I could get feedback on the structure & wording before Tuesday,
>     then I can start rolling it out on the main site. ____
>
>     __ __
>
>     There is still the possibility of making it prettier, with colour
>     coding or icons, and suggestions or comments are welcome.  (I think
>     this is Jen's domain...)  But getting it functional is the first
>     priority.____
>
>     __ __
>
>     We also need to come to a final decision about definitions of the
>     different states.  Specifically: should "In Progress" only be used
>     if the article is actively being edited, or for anything that is
>     half done?  What defines "Almost Done"?____
>
>     __ __
>
>     The mock-up, without custom CSS, looks like [1]:____
>
>     __ __
>
>
>       max-height____
>
>     */This article is Almost Done/*/:
>     Find out more about article readiness states
>     <http://docs.webplatform.org/test/Property:State>, or get involved
>     to help make Web Platform Docs better
>     <http://docs.webplatform.org/test/WPD:Contributors_Guide>! Already
>     signed up? Go to the edit page
>     <http://docs.webplatform.org/t/index.php?title=css/properties/max-height&action=edit>to
>     find out what still needs to be done.____/
>
>     Things to note:____
>
>     __ __
>
>     * It takes up a large chunk of real estate on the top of the page,
>     but remember that it will be replacing the big purple warning box
>     [2].  The extra text serves the same purpose as the warning box, but
>     now it's on a page-by-page basis instead of everywhere.____
>
>     __ __
>
>     * As agreed in the teleconference of April 29 [3], if the state is
>     marked "Ready to Use", nothing prints out.____
>
>     __ __
>
>     * Also as agreed, the status details field is not used at all on the
>     final page (View mode), but would still show up when editing the
>     form.  The form will also have a link to the Property page [4] with
>     definitions of the different states.____
>
>     __ __
>
>     * The info text is the same regardless of state, all that changes is
>     the "This article is..." heading.____
>
>     __ __
>
>     * The box uses the existing "Note" template, but the note is wrapped
>     in a div with a state-dependent class name, so we can target it
>     later for specific CSS (e.g. to match the colours and icons used on
>     the home page).  For Ready To Use articles, there is an empty div if
>     we decide to add an icon later. ____
>
>     __ __
>
>        If you want to play around with CSS, the final structure created
>     by the templates is ____
>
>     __ __
>
>            <div class="article-state State_Class"><div class="note">____
>
>                  <p><b>This article is {{{State}}}:</b><br/>____
>
>                        Find out more...</p>____
>
>            </div></div>____
>
>     __ __
>
>        where State_Class would be one of Ready_to_Use, Almost_Done,
>     In_Progress, Coming_Later, or Unreviewed.____
>
>     __ __
>
>     * For the test wiki, the above is currently encapsulated in its own
>     template [5], but for roll-out it would just replace the existing
>     flags template, and would appear on all pages that currently have
>     the ability to display flags.____
>
>     __ __
>
>     And of course, the template is just the first step.  Once we get it
>     up, we still have to go through and review everything to assign a
>     state!____
>
>     __ __
>
>     ...Amelia____
Received on Monday, 12 May 2014 02:25:11 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 21:21:01 UTC