W3C home > Mailing lists > Public > public-webplatform@w3.org > April 2013

Re: Place to put bug genie documentation.

From: Scott Rowe <scottrowe@google.com>
Date: Fri, 12 Apr 2013 13:35:24 -0700
Message-ID: <CAHZLcPp+5f_unKtuMNBC6j4=rnrppNvWYNDJFkSP3jA6n_wbcQ@mail.gmail.com>
To: Julee Burdekin <jburdeki@adobe.com>
Cc: Jonathan Garbee <jonathan@garbee.me>, "public-webplatform@w3.org" <public-webplatform@w3.org>
Right. You don't. I was just referring to extant pages. Ibid.


On Fri, Apr 12, 2013 at 11:56 AM, Julee Burdekin <jburdeki@adobe.com> wrote:

> If WPD: is there once, after wiki/, why would you need to repeat it?
> Thanks. J
>
>
> ----------------------------
> julee@adobe.com
> @adobejulee
>
> From: Scott Rowe <scottrowe@google.com>
> Date: Friday, April 12, 2013 10:53 AM
> To: Jonathan Garbee <jonathan@garbee.me>
> Cc: "public-webplatform@w3.org" <public-webplatform@w3.org>
> Subject: Re: Place to put bug genie documentation.
> Resent-From: <public-webplatform@w3.org>
> Resent-Date: Friday, April 12, 2013 10:54 AM
>
> Well the WPD: thing is kind of important as it separates the "meta"
> documentation from the content proper. So, we would move WPD:Projects to
> WPD:Project_Management/Projects. I was using the extant file names (like
> WPD:Projects and WPD:Filing_Bugs) to show the existing pages.
>
>
>
> On Fri, Apr 12, 2013 at 10:47 AM, Jonathan Garbee <jonathan@garbee.me>wrote:
>
>> I was thinking more along the lines of:
>> * WPD:Contributors_Guide
>> ** Editing
>> *** Getting Started
>> ** Project Mangement
>> *** Filing an issue
>> *** Voting on issues
>> *** Editing an issues attributes
>> ** Design
>>
>> With each lower level in the list simply being a sub-folder ( /
>> separator, we don't really use folders but that is the only thing I can
>> think to call it.) Doing WPD: so much just gets very repetitive very
>> quickly, and wouldn't even work doing WPD:Project_Management/WPD:Projects.
>>
>>
>> On Fri, Apr 12, 2013 at 1:42 PM, Scott Rowe <scottrowe@google.com> wrote:
>>
>>> Yes, I think that makes sense. Like this?:
>>>
>>> WPD:Contributors_Guide
>>>     WPD:Editors_Guide
>>>          WPD:Getting_Started
>>>          ...
>>>     WPD:Project_Management
>>>          WPD:Projects
>>>          WPD:Filing_Bugs
>>>          ...
>>>     WPD:Design
>>>     ...
>>>
>>> Then we need to revise the top-level nav, swaping "Editing" for
>>> "Contributing," and we'll need to write our Main_Page and anywhere else
>>> where we talk about contributing.
>>>
>>> Am I forgetting anything?
>>>
>>> ~Scott
>>>
>>>
>>>
>>>
>>>
>>> On Fri, Apr 12, 2013 at 9:55 AM, Jonathan Garbee <jonathan@garbee.me>wrote:
>>>
>>>> We really need an entire section of the wiki dedicated to these docs.
>>>> Doing it under another section such as the editors guide can get rough if
>>>> things move around in the future.
>>>>
>>>> Although, seeing this and doing some thinking I think we actually need
>>>> to move the Editors Guide around... What would probably make more sense is
>>>> a "Contributor's Guide" then have "Editing", "Design/Skin", "Project
>>>> Management", etc. as sub-sections of that. This way anyone wanting to
>>>> contribute in any way can go to one place to get the information they need.
>>>> Then under the PM section we could place the instructions on doing
>>>> different front-end tasks related to TBG.
>>>>
>>>> Does a restructure like that seem reasonable to anyone else?
>>>>
>>>>
>>>> On Fri, Apr 12, 2013 at 12:00 PM, Julee <julee@adobe.com> wrote:
>>>>
>>>>> Hi, Garbee:
>>>>>
>>>>> How about:
>>>>>
>>>>>
>>>>> http://docs.webplatform.org/wiki/WPD:Editors_Guide/step_2_communicate_with_the_online_community#Access_the_bug-tracking_system
>>>>>
>>>>> Julee
>>>>> ----------------------------
>>>>> julee@adobe.com
>>>>> @adobejulee
>>>>>
>>>>> From: Jonathan Garbee <jonathan@garbee.me>
>>>>> Date: Friday, April 12, 2013 6:23 AM
>>>>> To: "public-webplatform@w3.org" <public-webplatform@w3.org>
>>>>> Subject: Place to put bug genie documentation.
>>>>> Resent-From: <public-webplatform@w3.org>
>>>>> Resent-Date: Friday, April 12, 2013 6:23 AM
>>>>>
>>>>> So, today I am finishing up the new Filing Bugs tutorial [1] with
>>>>> pictures and all to hopefully make filing someones first issue more clear.
>>>>> I plan on currently just tweaking the current page to hold that content.
>>>>> Something we need to figure out though is where to place the other Bug
>>>>> Genie documentation that is being done. I originally thought to place it
>>>>> under WPD:TBG and have sub-pages from there on different usage tasks, but I
>>>>> feel "TBG" doesn't make much sense unless you know what it is.
>>>>>
>>>>> Does anyone have any thoughts on where we should put the docs? Do
>>>>> remember that there will really be two views in the documentation, one for
>>>>> front-end usage and one for administrating the system.
>>>>>
>>>>> Thanks,
>>>>> -Garbee
>>>>>
>>>>> [1] http://docs.webplatform.org/wiki/WPD:Filing_Bugs
>>>>>
>>>>
>>>>
>>>
>>
>
Received on Friday, 12 April 2013 20:35:55 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:13:45 UTC