154
edits
Changes
Jump to navigation
Jump to search
Line 135:
Line 135: − + + + + + + + + + + + + Line 145:
Line 156: − + + +
Summer of Code/2018/attentive migration of wiki activity pages to git (view source)
Revision as of 05:42, 30 March 2018
, 05:42, 30 March 2018Update from pdf
:* Step 1: Query wiki.sugarlabs.org to get list of all pages to convert
:* Step 1: Query wiki.sugarlabs.org to get list of all pages to convert
:* Step 2: For each page, research and find out(or discuss as needed with mentor/community) where to place them in GitHub
:* Step 2: For each page, research and find out(or discuss as needed with mentor/community) where to place them in GitHub
::{{highlight | Add stuff here. Please read .pdf version}}
::<code>
:: We have three audiences for documentation,
:: a) users; such as children who are learners, and their teachers
:: b) integrators; who join many activities into a system,
:: c) developers; who develops Sugar and maintains its activities.
::Activity pages does not only conatins user documentation, but also developer documentation. Some activity pages have both, some have only one or the other.
::example:
::1. [[Activities/TamTam]] is developer documentation, and should be moved to [https://github.com/sugarlabs/tamtam tamtam]
::2. [[Activities/Story]] is user documentation, and should be moved to [https://github.com/godiard/help-activity help-activty]
::3. [[Activities/Physics]] is both, Some decision will be needed on a case to case basis to deal with these pages.
</code>
:* Step 3: For each GitHub repository to push converted files:
:* Step 3: For each GitHub repository to push converted files:
:** 3.1: Fork the repository
:** 3.1: Fork the repository
:*** generate one temporary duplicate file(containing raw wikitext), for conversion
:*** generate one temporary duplicate file(containing raw wikitext), for conversion
:*** using pandoc, convert
:*** using pandoc, convert
:**** {{highlight | Add stuff here. Please read .pdf version}}
:**** <code> to Markdown or reStructuredText? </code>
:***** <code>for content that is to be in the corresponding source repository in GitHub, use .md</code>
:***** <code>for user documentation content that is to be in the Help Activity in Sugar, use .rst</code>
:*** while the conversion is not perfect (it is difficult or sometimes not-possible, to generate the exact functionalities of a wiki-page into a markdown file. For example, image-galleries)
:*** while the conversion is not perfect (it is difficult or sometimes not-possible, to generate the exact functionalities of a wiki-page into a markdown file. For example, image-galleries)
:**** modify the temporary wikitext file, with attention to every small detail
:**** modify the temporary wikitext file, with attention to every small detail