request for documentation page and location to put it

steve steve at openmoko.com
Sat Aug 9 18:27:57 CEST 2008 

The front page is still too cluttered and needs to be reorganized along
simpler lines

For example.

1Products
2Developer resources
3Community

1Products
1.1 1973
1.2 Neo 1973
1.3 Freerunner

 1.3 FreeRunner.
   1.3.1 Distributions
   1.3.2 Hardware specs
   1.3.3.Know issues
   1.3.4 cad files
   1.3.5 Schematics.

Like so. Logical.


 

-----Original Message-----
From: Michael Shiloh [mailto:michael at openmoko.org] 
Sent: Saturday, August 09, 2008 9:09 AM
To: steve
Cc: 'Justin Wong'; 'openmoko documentation'; Brenda Wang
Subject: Re: request for documentation page and location to put it

Good point.



steve wrote:
> Do not front page this stuff.
> 
> The front page should drive readers to a PRODUCT PAGE
> 
> And the the product page would have known issues etc.
> 
> Imagine when we have 3 products? By front paging known issues your 
> create a MESS Of a front page.
> 
> 
> -----Original Message-----
> From: Michael Shiloh [mailto:michael at openmoko.org]
> Sent: Wednesday, August 06, 2008 8:53 PM
> To: Justin Wong
> Cc: openmoko documentation; steve
> Subject: Re: request for documentation page and location to put it
> 
> I think the FAQ and the "known issues" are two separate categories, 
> and both are needed.
> 
> "How do I set up USB networking" is an FAQ The audible buzzing is a 
> Known Issue.
> 
> I suppose every Known Issue is also an FAQ ("what is buzzing sound?"), 
> but not every FAQ is a Known Issue.
> 
> Perhaps the main page should have the top 10 (or 5) Known Issues and 
> FAQs, and then links to the full collection.
> 
> Just my opinion. I defer to those actually doing the work.
> 
> Michael
> 
> 
> 
> Justin Wong wrote:
>> Hi Michael,
>>
>> Yes, definitely from what I can see currently, the wiki would be the 
>> first place I'd look if I was in that scenario.
>>
>> "Known issues" are good keywords to look for.  Perhaps we can 
>> transform the "Getting Started FAQ" by renaming it "Known Issues".  
>> It seems like that the "Getting Started FAQ" is trying serve the 
>> known issues purpose.
>>
>> Cheers!
>> Justin
>>
>>
>> On Fri, Aug 1, 2008 at 11:38 PM, Michael Shiloh 
>> <michael at openmoko.org>
> wrote:
>>> Justin,
>>>
>>> You are quite right. The bug tracking system will be fine for this info.
>>>
>>> I think it would be useful to have perhaps the most common or 
>>> perhaps most apparent or perhaps most offensive bugs listed on the 
>>> wiki main page, with a pointer to the TRAC item.
>>>
>>> I'm having a bit of trouble identifying exactly what problem I'm 
>>> trying to solve and how to solve it. Perhaps you can help:
>>>
>>> Look at it from the point of view of a new user (still developer, 
>>> like us, but new to the community). You get the device and charge it 
>>> up and find that your SIM card doesn't work and/or GPS doesn't work 
>>> or
> whatever.
>>> Had you been on the mailing list for the past couple of weeks you 
>>> would know exactly what is going on. But you just joined. So you 
>>> visit
> the wiki.
>>> Would you expect to find this on the wiki, and, if so, what keywords 
>>> would you expect?
>>>
>>> To me, "Known Issues" are the keywords I would look for.
>>>
>>> Thoughts?
>>>
>>> Michael
>>>
>>> Justin Wong wrote:
>>>> Hi Michael,
>>>>
>>>> Just wondering what the difference between this and a bug tracking 
>>>> system would be.
>>>>
>>>> It sounds like a bug tracking system could maintain all that 
>>>> information about "known issues" and would do it in a more 
>>>> efficient manner than the wiki.
>>>>
>>>> So we need to think of is how to link the wiki and the bug tracking 
>>>> system together?  Or perhaps no link is necessary and just pointing 
>>>> to it is enough.  I don't know.
>>>>
>>>> As for a place to answer frequent questions, I think the FAQ would 
>>>> be a good place, but it needs to be organized in an efficient manner.
>>>>
>>>>
>>>> Cheers!
>>>> Justin
>>>>
>>>>
>>>> On Fri, Aug 1, 2008 at 7:55 PM, Michael Shiloh 
>>>> <michael at openmoko.org>
>>>> wrote:
>>>>> Many people come to the wiki when something doesn't work. I've 
>>>>> been trying to figure out the best way to help them, and I've come 
>>>>> up with this idea. Please tell me what you think:
>>>>>
>>>>> 1. Have a "known issues" section prominently displayed on the main 
>>>>> page, perhaps near the top.
>>>>>
>>>>> 2. Each known issue should include the symptoms and a diagnostic 
>>>>> (so that a user can determine whether the problem they are 
>>>>> experiencing is in fact this known issue). Diagnostics might be 
>>>>> sparse when an issue first becomes known, and will become clearer 
>>>>> as we
> learn about the issue.
>>>>> 3. Each known issue will also (hopefully :-) feature a solution 
>>>>> section, although initially it might be empty.
>>>>>
>>>>> 4. After a known issue is solved, and the patches are present in 
>>>>> daily builds, and enough time has elapsed to prove it is really 
>>>>> solved the issue must be removed from the "known issues" section 
>>>>> so that the wiki remains uncluttered.
>>>>>
>>>>> This also raises the question of historical items. Once things are 
>>>>> over and done, removing from the wiki would avoid confusion. On 
>>>>> the other hand, history is good. Not sure how best to handle this, 
>>>>> but it's lower priority I think.
>>>>>
>>>>> Michael
>>>>>
>>>>> -------- Original Message --------
>>>>> Subject: FW: Sim card is not working, how do I run diagnostics?
>>>>> Date: Sun, 20 Jul 2008 14:32:02 -0700
>>>>> From: steve <steve at openmoko.com>
>>>>> To: William Lai <will at openmoko.com>,    Neng-Yu Tu (Tony Tu)
>>>>> <tony at openmoko.com>,    Michael Shiloh <michael at openmoko.org>
>>>>> CC: Sean Moss-Pultz <sean at openmoko.com>
>>>>>
>>>>>
>>>>> We need a place where people can go to get this informtion
>>>>>
>>>>> Wiki is NOT good enough
>>>>>
>>>>> Mailing list is a nightmare, like asking the sphinx.
>>>>>
>>>>>
>>>>> -----Original Message-----
>>>>> From: community-bounces at lists.openmoko.org
>>>>> [mailto:community-bounces at lists.openmoko.org] On Behalf Of Adam 
>>>>> Talbot
>>>>> Sent: Friday, July 11, 2008 3:23 PM
>>>>> To: List for Openmoko community discussion
>>>>> Subject: Re: Sim card is not working, how do I run diagnostics?
>>>>>
>>>>> And I am stuck
>>>>> I have 3 brand new sim cards.
>>>>> 71234G
>>>>> 71234O
>>>>> 71234D
>>>>> None of which work in my FreeRunner. What does the reading of the SIM?
>>>>> How do I look at that for bugs, and perhaps a bug fix.  What is 
>>>>> needed on the SIM, is it just the S/N?  Can I reprogram a S/N for 
>>>>> an unactivated card to one of my old working chips? Then call AT&T 
>>>>> and get it activated?
>>>>> Any ideas?
>>>>> -Adam
>>>>>
>>>>>
>>>>>
>>>>> On Thu, 2008-07-10 at 22:39 -0700, Adam Talbot wrote:
>>>>>> I am a tinker, left on my own (+google) I can figure out almost 
>>>>>> anything :-)
>>>>>>
>>>>>> Sim cards.  Here is the "how to" check.
>>>>>> Follow this until you get an OK prompt.
>>>>>> http://www.openmoko.org/wiki/Manually_using_GSM
>>>>>>
>>>>>> >From there your first command should be at+cimi.  If it returns
>>>>>>> the
>>>>>>> S/N
>>>>>> of your card, you have a working card.  If not (ERROR), you are 
>>>>>> out of luck.
>>>>>> Here are the cards I tested:
>>>>>> AT&T, blue front, purple/blue-green back.   Worked.
>>>>>> AT&T, All white. Worked.
>>>>>> Cingular, 73000O (4021)  Worked.
>>>>>> Cingular, 63512A (1002)  Worked.  FR hung on boot, may be unrelated.
>>>>>> Reboot fixed it.
>>>>>> AT&T, 71234G (3022)  I have two, both failed.
>>>>>> Should there be a global SIM card compatibility section? Like 
>>>>>> this, just MUCH bigger?
>>>>>> http://www.openmoko.org/wiki/Carriers/ATT
>>>>>>
>>>>>> I am running a Freerunner +
>>>>>>
>>>>> Openmoko-openmoko-devel-image-glibc-ipk-P1-Snapshot-20080710-om-gt
>>>>> a 02.rootfs .jffs2, my provider is AT&T, out of California.
>>>>>> Hope this helps.
>>>>>> -Adam
>>>>>>
>>>>>>
>>>>>> http://www.openmoko.org/wiki/Manually_using_GSM
>>>>>> On Thu, 2008-07-10 at 19:59 -0700, Adam Talbot wrote:
>>>>>>> My sim card is not working, how do I run diagnostics? I was 
>>>>>>> looking on the Wiki, but searching for sim turns up nothing 
>>>>>>> worth while.  I have a pile of sim card to work with, each
different.
>>>>>>> Would love to test them out.  Where is the "how to"?
>>>>>>> -Adam
>>>>>>>
>>>>>> _______________________________________________
>>>>>> Openmoko community mailing list
>>>>>> community at lists.openmoko.org
>>>>>> http://lists.openmoko.org/mailman/listinfo/community
>>>>> _______________________________________________
>>>>> Openmoko community mailing list
>>>>> community at lists.openmoko.org
>>>>> http://lists.openmoko.org/mailman/listinfo/community
>>>>>
>>>>>
>>>>> _______________________________________________
>>>>> documentation mailing list
>>>>> documentation at lists.openmoko.org
>>>>> https://lists.openmoko.org/mailman/listinfo/documentation
>>>>>
>

More information about the documentation mailing list