Migrate Documentation from wiki-pages

[rdrsadhu]

This Pull Request migrates wiki-pages of Abacus Activity from https://wiki.sugarlabs.org/go/Activities
specifically these 4 pages:

1. https://wiki.sugarlabs.org/go/Activities/Abacus
2. https://wiki.sugarlabs.org/go/Activities/Abacus/Abacos
3. https://wiki.sugarlabs.org/go/Activities/Abacus/Worksheet
4. https://wiki.sugarlabs.org/go/Activities/Abacus/Worksheet/Answersheet

Description:
For page:

1. this page was derived to abacus.rst some time ago, and nothing new has been added since then

• hence it is needless to duplicate the content

2. Spanish Translation of page 1.

• I guess, this page also need not be migrated because, the Help-Activity automatically renders a translated page, according to the user language-preference

3. this page is a lesson plan for learning Abacus. It has been translated to markdown and included in this PR
4. this page contains answers to the lesson plans of page 3. It has also been translated to markdown and included in this PR

Some Help Needed:

1. Should the original wikitext source files be kept for future reference?
   (I have them exactly the state they were, before being converted to markdown)
2. How to exclude the docs folder from the activity bundle?
   (the docs folder may grow the activity bundle size unnecessarily)

Steps to perform after this Pull Request gets merged:

• Pull Request to update abacus.rst which

• changes Some lesson plans link at line 316 to docs/Worksheet.md
• removes wiki-page reference at the last line

• Delete wiki-pages 1,2,3,4 and all of its associated extra images/files

This is in reference to the GSoC 2018 Project: Migration of wiki Activity pages to git
The complete process is done running a script with minimum manual interventions.

[quozl]

https://wiki.sugarlabs.org/go/Activities/Abacus/Worksheet
https://wiki.sugarlabs.org/go/Activities/Abacus/Worksheet/Answersheet
... a lesson plan for learning Abacus. It has been translated to markdown and included in this PR
... answers to the lesson plans of page 3. It has also been translated to markdown and included in this PR

These should be added to https://github.com/sugarlabs/help-activity/blob/master/source/abacus.rst because they are user documentation?

Should the original wikitext source files be kept for future reference?

No.

How to exclude the docs folder from the activity bundle?

May not be a problem given the above suggestion, but;

• minimise the size of the docs folder,
• assess the size of the docs folder relative to the activity bundle,
• if the ratio is significant (e.g. > 50% docs), write a custom setup.py which excludes the folder, or ask for a toolkit feature to exclude files. In December there was a custom setup.py written in Polari activity.

By the way, you didn't add the new files to README.md.

[Saichethan]

Did you add images manually by downloading every single image? If so, I'm afraid you should have already noticed how much time it would take for most of 300 wiki activity pages look for more sustainable method
@quozl correct me if I am wrong?

[quozl]

@Saichethan, thus far I'm not reviewing the script or method, I'm reviewing the result. I imagine that the conversion would fetch only the images that were referenced.

[rdrsadhu]

These should be added to https://github.com/sugarlabs/help-activity/blob/master/source/abacus.rst because they are user documentation?

you mean, these files are to be included in the 'source' folder of help-activity?
also, where should the Pull Request be directed? sugarlabs/help-activity or godiard/help-activity

you didn't add the new files to README.md

because, the README.md already has a reference to user documentation in 'How to use Abacus'

Did you add images manually by downloading every single image?

No.
for any given wiki-page, the script first fetches a list of all images/files used in the page
then gets the urls of those specific pages, and ultimately fetches them.
Sometimes manual supervision is needed only to modify the path of external files used in the converted document

[quozl]

included in the 'source' folder of help-activity?

You decide and defend your decision. The abacus.rst file is in the source directory, yes. Content could be added to that file, with any reorganisation of sections. Or if the content does not logically flow from what is there already, add abacus_worksheet.rst and abacus_worksheet_answers.rst files.

where should the Pull Request be directed?

You decide and defend your decision. Where there is a choice of repository, and one is a fork of the other, then it would most typical to make a pull request to the top-most repository in the fork structure. https://github.com/sugarlabs/help-activity is a fork of https://github.com/godiard/help-activity and I'm a collaborator on both.

[Saichethan]

@rdrsadhu what did you use for making that script would you mind if can have some insights on that ?

[rdrsadhu]

Thanks @quozl and @Saichethan ,
I've made a PR at godiard/help-activity

what did you use for making that script

MediaWiki API

[quozl]

Given merge of godiard/help-activity@f7017e1 probably we're waiting for someone to delete https://wiki.sugarlabs.org/go/Activities/Abacus is that right?

[rdrsadhu]

yes,
I'm waiting for godiard/help-activity#40 to get merged

[quozl]

It was.

[rdrsadhu]

Merged at godiard/help-activity#38