Port help.sl.o Documentation

[pipix51]

This pull request partially fixes #97. I ported some of the help documentation-

• created help folder to put all the documentation
• created articles for Using Sugar, Using Activities, Network, Support, Glossary, Abacus and Browse
• created assets folder to store images

[quozl]

Thanks, quite interesting.

Well done, you are very brave! Consensus in #97 was not reached or defined; @davelab6 wants the user documentation included in developer.sugarlabs.org, but @godiard and @walterbender signalled unwillingness. Discussion ceased once positions were made clear.

Was yours an automated process, or editing by hand?

How will your edits be brought back into the Help activity?

How will future edits to the Help activity be automatically made here?

Background to my questions;

The Help activity is user documentation for offline and online use. While offline or online, a user of Sugar can press alt-shift-h, or right-click on the Frame icon for an activity to open the Help in context. Online, anyone can visit help.sugarlabs.org using a web browser.

I've no opinion on whether the Help activity content should be added to developer.sugarlabs.org, but if it is added then there must be some automatic system to keep both in synchronisation. As a community we don't have the resources to keep the Help activity up to date, so we certainly won't have the resources to keep a different copy of Help up to date as well.

Hope you see my problem? 😁

godiard/help-activity#35

[pipix51]

Apologies, #97 was a GCI task, and the task description stated that porting the documents over was an imperative. Currently the documents are edited by hand.

I presumed the help documentation was a legacy document as it had not been updated since 2015, hence little to no edits should be needed.

[walterbender]

I am OK with the Sugar help being incorporated. But I don't think we need the OLPC-specifc help here. But I agree that without an automated process, we will not be able to maintain this. So we'd want some script for scraping the help activity content.

…

On Tue, Jan 9, 2018 at 3:55 AM, pipix51 ***@***.***> wrote: Apologies, #97 <#97> was a GCI task, and the task description stated that porting the documents over was an imperative. Currently the documents are edited by hand. I presumed the help documentation was a legacy document as it had not been updated since 2015, hence little to no edits should be needed. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#137 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADz74e4yMuerummAXn_2WX4EDCgYpZDOks5tIymMgaJpZM4RWQi2> .

-- Walter Bender Sugar Labs http://www.sugarlabs.org <http://www.sugarlabs.org>

[quozl]

@pipix51 said;

it had not been updated since 2015

Where are you looking to discern this? https://github.com/godiard/help-activity/commits/master has plenty of activity.

@walterbender said;

I am OK with the Sugar help being incorporated. But I don't think we need the OLPC-specifc help here.

Agreed. I've been maintaining an OLPC-specific fork of the Help activity. But for Sugar Labs I would like the OLPC-specific content to vanish from the Help activity, so it can be used by the Sugar Live Build and other distributions of Sugar.

[quozl]

Closing, as the conversion is not automated. With the move to GitHub hosting for sugar-docs, we can also link directly to the help activity.