[Sugar-devel] Introduction and review request of GSoC Proposal:

[James Cameron]

Thanks, I've reviewed your updated proposal.

My assessment of project impact;

Originally documentation was separate because we had non-coding
developers and tool chains that varied by type of developer.  Now we
use GitHub the tool chains are combined.

With the project as described, documentation will be concentrated in
the source code repository for an activity, reducing ongoing
maintenance.

We have less active Wiki contributors than we ever did, and in the
current threat environment a Wiki requires significant monitoring and
administration; we recently lost some system administrators and gained
new ones; using GitHub allows us to outsource system administration.

On Sun, Mar 25, 2018 at 08:06:49PM +0530, Rudra Sadhu wrote:
> Thanks James, Carlos, Gonzalo and everyone for the insights
> 
> Your inputs helped a lot, and I've updated my proposal accordingly.
> A lot of important stuff was added such as the working the Help Activity,
> keeping check on the activity bundle sizes and completing the miscellaneous
> section.
> 
> The proposal is available at [1]https://wiki.sugarlabs.org/go/Summer_of_Code/
> 2018/attentive_migration_of_wiki_activity_pages_to_git
> I've also shared the same via the GSoC dashboard
> Please read, most importantly the 'About Project' section
> 
> Let me know of the stuff I should add/remove/update to better justify the
> task. 
> 
> also It would help, if someone volunteers to answer the impact of this project
> required to be filled in as an answer in the 'Project and the Community'
> section 
> 
> Thanks
> Rudra Sadhu
> 
> On Wed, Mar 21, 2018 at 5:46 PM, Rudra Sadhu <[2]rdrsadhu at gmail.com> wrote:
> 
>     Thanks James,
>     the resources you mentioned were really helpful.
> 
>     I went ahead to migrate a few of the pages by the guidelines you described.
>     Find the Pull Request here: [3]https://github.com/sugarlabs/activity-abacus
>     /pull/13
> 
>     Please review
> 
>     On Wed, Mar 21, 2018 at 4:32 AM, James Cameron <[4]quozl at laptop.org> wrote:
> 
>         On IRC #sugar Vipul Gupta asked;
> 
>         <vipulgupta2048> Hey, in the Activity task of migration. We need to
>         migrate content from activities page to their Githubs or their git
>         pages.
> 
>         <vipulgupta2048> ?
> 
>         <vipulgupta2048> Please clarify which one is it. Some pages don't have
>         the links of their repository
> 
>         <vipulgupta2048> The organisations is not uniform. I have included
>         this in my proposal too.
> 
>         <Quozl_> vipulgupta2048: need to write a program that will migrate
>         content from [5]wiki.sugarlabs.org activities page to respective GitHub
>         repository README.md files, yet without duplicating what is there, and
>         without duplicating user documentation in the help-activity, see
>         recent posts to sugar-devel@ discussing the issue.
> 
>         <Quozl_> vipulgupta2048: did you get the above?  if not, i'll have to
>         write a mail.
> 
>         My recent post is quoted below and can be found in the mailing list
>         archives.
> 
>         On Wed, Mar 14, 2018 at 06:04:02PM +1100, James Cameron wrote:
>         > G'day Rudra,
>         >
>         > Thanks for being at the meeting earlier, and for your proposal.
>         >
>         > A project for GSoC 2013 added context sensitive help, or user
>         > documentation, to the Sugar desktop, with alt+shift+h key.
>         >
>         > It works with the Help activity.  Metadata in the Help activity links
>         a
>         > subject activity to a markdown source file, which is converted to
>         HTML
>         > and rendered in a tiny browser.
>         >
>         > Many of these source files came from the Wiki pages of activities,
>         and
>         > have been updated since then.
>         >
>         > Please review and integrate the Help activity into your proposal; for
>         > instance;
>         >
>         > - avoid duplicating user documentation into activity repositories,
>         >   because that would make for unncessary maintenance burden, or;
>         >
>         > - move some of the Help activity files into activity repositories and
>         >   provide a way to update the Help activity from the subject
>         >   activities.
>         >
>         > Please review the discussion on these two pull requests;
>         >
>         > [6]https://github.com/sugarlabs/activity-abacus/pull/12
>         > [7]https://github.com/sugarlabs/sugar-docs/pull/137
>         >
>         > And then ask any questions to clarify, thanks.
>         >
>         > --
>         > James Cameron
>         > [8]http://quozl.netrek.org/
> 
>         --
>         James Cameron
>         [9]http://quozl.netrek.org/
> 
> References:
> 
> [1] https://wiki.sugarlabs.org/go/Summer_of_Code/2018/attentive_migration_of_wiki_activity_pages_to_git
> [2] mailto:rdrsadhu at gmail.com
> [3] https://github.com/sugarlabs/activity-abacus/pull/13
> [4] mailto:quozl at laptop.org
> [5] http://wiki.sugarlabs.org/
> [6] https://github.com/sugarlabs/activity-abacus/pull/12
> [7] https://github.com/sugarlabs/sugar-docs/pull/137
> [8] http://quozl.netrek.org/
> [9] http://quozl.netrek.org/

-- 
James Cameron
http://quozl.netrek.org/