[Owncloud] Suggestion: general help framework

[Frank Karlitschek]

On 11.09.2012, at 07:22, Michael Gapczynski <mtgap at owncloud.com> wrote:

> I like the idea Christian. We could also use some improvements on the documentation on the website. For the welcome page, could we show a nice overlay for a new user with a short guide. How to upload files, share a file, moving files, setup webdav client, etc. Rather than the user stumbling around. This content could probably be the same as the help section.

Perhaps I´m missing fantasy but I only see one option here. :-)
We should have a basic help included in ownCloud for stuff like "how to upload" and "how to share." At the end the help text we add a "more" button than links to the website for more extensive documentation. The shipped short documentation has to be in git but this shouldn´t be a problem because this is only short anyways and the more extensive documentation is online.
No?
So +1 from me to Christian if you want to implement this :-)

> @Thomas
> Some of those topics including this one could easily be discussed further in IRC or by email. This way there can be a basic plan in place, which allows for more time focused on actual implementation at the meeting. I believe this is what Frank is getting at.

Exactly. 



> Michael
> 
> Thomas Müller <thomas.mueller at tmit.eu> wrote:
> 
>> 
>> Am Montag, dem 10.09.2012 um 15:46 schrieb Frank Karlitschek:
>>> On 10.09.2012, at 15:38, Thomas Müller <thomas.mueller at tmit.eu> wrote:
>>> 
>>>> 
>>>> Am Montag, dem 10.09.2012 um 15:01 schrieb Thomas Tanghus:
>>>>> On Monday 10 September 2012 11:22 Christian Reiner wrote:
>>>>>> Ok, this is my suggestion. 
>>>>>> Any comments?
>>>>> 
>>>>> I think it is an excellent idea. Apparently I didn't notice your original 
>>>>> proposal.
>>>>> 
>>>>> Currently we have the knowledgebase under settings/help.php which also offers 
>>>>> a few links to documentation, but AFAIRC it is very unstructured (it couldn't 
>>>>> connect via OCSClient so I can't say how it looks now).
>>>>> 
>>>>> We should have a reliable service that could be queried for up-to-date info to 
>>>>> be provided either as context sensitive help (bubble/popup) and for more 
>>>>> general help, as the welcome page you mentioned.
>>>>> 
>>>>> Maybe we could simply store it in a git repository as 
>>>>> markdown/text/wiki/whatever.
>>>>> 
>>>> 
>>>> Just FYI:
>>>> we have a topic on the dev meeting in Berlin about this:
>>>> http://owncloud.org/dev/planned-topics-for-developer-meeting-autumn-2012/
>>>> 
>>>> - Community Interaction / mailing list / forum / deciding on one help platform
>>>> 
>>>> Let's summarize all ideas and discuss them in Berlin.
>>> 
>>> In general I agree. But let´d not postpone everything to the meeting. We already have more topics tan we can discuss and not everybody is in Berlin.
>>> 
>>> Plus I think that a help framework as discussed is useful independently from the mailing-list / forum / online help discussion.
>>> 
>> 
>> From my understanding this is for sure belongs to this topic.
>> In addition we need to keep them all updated and in sync and I don't see who can maintain this.
>> 
>> (We already lack on devs (e.g. Gallery is not maintained for weeks) - postings on ML stay unanswered...)
>> 
>> Before starting something new we need to the the current situation sorted out.
>> We agreed to discuss this in Berlin.
>> 
>> As stated above: let's collect ideas.
>> 
>>> 
>>> So if someone has an idea how to do this and is motivated to implement it than I see no point in postponing this. :-)
>>> 
>>> Frank
>> _______________________________________________
>> Owncloud mailing list
>> Owncloud at kde.org
>> https://mail.kde.org/mailman/listinfo/owncloud