Activities/Help/Contribute - Revision history

Quozl at 05:15, 4 August 2017

2017-08-04T05:15:36Z

← Older revision		Revision as of 01:15, 4 August 2017
Line 107:		Line 107:

	* In any other Linux environment		* In any other Linux environment
	The output ~~of make~~ html ~~is in /mainline~~/~~html~~, and is opened by opening		The output directory {{Code\|html/}}, and is opened by opening
	index.html in a browser, it is easy to see the changes as you work.		{{Code\|html/index.html}} in a browser, so it is easy to see the changes as you work.

	== Further reading ==		== Further reading ==
Line 130:		Line 130:
	b. or in the event you wish to make changes to the index, over and above, adding a new line to the bottom a table of contents as described in the tutorials,		b. or in the event you wish to make changes to the index, over and above, adding a new line to the bottom a table of contents as described in the tutorials,

	you may delete all the output files, that is, {{Code\|~/~~mainline~~/html/}} and {{Code\|~/~~mainline~~/doctrees/}}. They will be regenerated by {{Code\|make html}}.		you may delete all the output files, that is, {{Code\|~/help-activity/html/}} and {{Code\|~/help-activity/doctrees/}}. They will be regenerated by {{Code\|make html}}.

	=== Reconfigure Help to show View source ===		=== Reconfigure Help to show View source ===
Line 136:		Line 136:
	In Sugar as we already have a View source button in the Frame.		In Sugar as we already have a View source button in the Frame.

	If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code\|~/~~mainline~~/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code\|conf.py}} and change the value in the code line like this.		If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code\|~/help-activity/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code\|conf.py}} and change the value in the code line like this.

	# Custom sidebar templates, maps document names to template names. ## Edit: Sugar default is without 'sourcelink.html'		# Custom sidebar templates, maps document names to template names. ## Edit: Sugar default is without 'sourcelink.html'

Quozl: /* How to get freshest Help sources */

2017-08-04T05:07:34Z

How to get freshest Help sources

← Older revision		Revision as of 01:07, 4 August 2017
Line 93:		Line 93:
	You can install it in your development environment doing:		You can install it in your development environment doing:

	cd ~~mainline~~		cd help-activity
	./setup.py dev		./setup.py dev
	(if you have the activity already installed, uninstall it first)		(if you have the activity already installed, uninstall it first)

Quozl at 04:21, 4 August 2017

2017-08-04T04:21:14Z

← Older revision		Revision as of 00:21, 4 August 2017
Line 21:		Line 21:
	Users actively involved, who are prepared to review the work of contributors:		Users actively involved, who are prepared to review the work of contributors:

	Please add ~~you~~ name ...		* [[User:Quozl]]

			Please add your name ...

	== TODO ==		== TODO ==

Quozl: did not review contributions for past year and a half, so remove.

2017-08-04T04:20:20Z

did not review contributions for past year and a half, so remove.

← Older revision		Revision as of 00:20, 4 August 2017
Line 20:		Line 20:

	Users actively involved, who are prepared to review the work of contributors:		Users actively involved, who are prepared to review the work of contributors:

	~~[[User:Inkyfingers]]~~

	Please add you name ...		Please add you name ...

Quozl: /* Wish list for new documentation */

2015-08-15T07:36:15Z

Wish list for new documentation

← Older revision		Revision as of 03:36, 15 August 2015
Line 44:		Line 44:
	Compare with the old content, and check if something is missing http://dev.laptop.org/~gonzalo/old_help/XO_Introduction.html		Compare with the old content, and check if something is missing http://dev.laptop.org/~gonzalo/old_help/XO_Introduction.html

	Keyboard shortcuts - not yet well covered.		Keyboard [[Hotkeys\|shortcuts]] - not yet well covered.

	Please add any item you see missing.		Please add any item you see missing.

Inkyfingers at 16:38, 11 February 2015

2015-02-11T16:38:17Z

← Older revision		Revision as of 12:38, 11 February 2015
Line 1:		Line 1:
	This page aims to inform anyone interested in contributing to Sugar documentation~~, Help 18 and beyond~~.		This page aims to inform anyone interested in contributing to Sugar documentation.

	~~Pre release, XO Help 17 is available by following [[#How to get freshest Help sources]]~~		This page acts as a "Landing page" for those who have read "How to edit Help and contribute" in XO Help, and to encourage others to test it.

	This page acts as a "Landing page" for those who have read "How to edit Help and contribute" in XO Help 17, and to encourage others to test it.

	Any updates to the technical contents of that page will be announced here. Please see [[#Known issues]].		Any updates to the technical contents of that page will be announced here. Please see [[#Known issues]].

Godiard: /* How to get freshest Help sources */

2014-10-22T22:12:55Z

How to get freshest Help sources

← Older revision		Revision as of 18:12, 22 October 2014
Line 90:		Line 90:

	To see work in progress since the previous XO Help, this command:		To see work in progress since the previous XO Help, this command:
	git clone ~~gitorious@git~~.~~sugarlabs.org:~~help~~/mainline~~.git		git clone https://github.com/godiard/help-activity.git
	you will get the Help Activity _with_ the sources included.		you will get the Help Activity _with_ the sources included.

Godiard at 16:24, 14 January 2014

2014-01-14T16:24:16Z

← Older revision		Revision as of 12:24, 14 January 2014
Line 29:		Line 29:
	== TODO ==		== TODO ==

	This is a list of topics we need improve in the help content (--[[User:Godiard\|Godiard]] ([[User talk:Godiard\|talk]]) 11:23, 14 January 2014 (EST) Jan 14, 2014)		This is a list of topics we need improve in the help content (--[[User:Godiard\|Godiard]] ([[User talk:Godiard\|talk]]) 11:24, 14 January 2014 (EST) Jan 14, 2014)

	* Browse activity: need add a section about collaboration, explaining how works (sharing favorite pages)		* Browse activity: need add a section about collaboration, explaining how works (sharing favorite pages)

Godiard at 16:23, 14 January 2014

2014-01-14T16:23:58Z

← Older revision		Revision as of 12:23, 14 January 2014
Line 26:		Line 26:

	Please add you name ...		Please add you name ...

			== TODO ==

			This is a list of topics we need improve in the help content (--[[User:Godiard\|Godiard]] ([[User talk:Godiard\|talk]]) 11:23, 14 January 2014 (EST) Jan 14, 2014)

			* Browse activity: need add a section about collaboration, explaining how works (sharing favorite pages)
			* Collaboration page: need show how invite to a friend works.

	== XO Help Contents ==		== XO Help Contents ==

Inkyfingers: collaboration, link - Activity documentation template

2013-12-14T11:40:28Z

collaboration, link - Activity documentation template

← Older revision		Revision as of 07:40, 14 December 2013
Line 75:		Line 75:

	Any suggestions welcome for a repository for "Documentation - work in progress".		Any suggestions welcome for a repository for "Documentation - work in progress".

			The paragraph [[Documentation Team/Notes/1.0#Activity documentation template]] demonstrates a model for collaboration. Here the wiki page for Portfolio, [[Activities/Portfolio]], was edited into the preferred format, and then lifted straight into "the documentation project".

			Where wiki pages are suitable for transfer to Help they could be highlighted here.

	== How to get freshest Help sources ==		== How to get freshest Help sources ==