Changes

Imagine you are now reading - Sweets/Getting started
Line 8: Line 8:  
I propose to paste below: [[Platform_Team/Guide/Sweets_Usage]]] ...
 
I propose to paste below: [[Platform_Team/Guide/Sweets_Usage]]] ...
   −
Then I cut the introduction and first paragraph. What are the opportunities of improving documentation for users at a certain point, after install and before successful launch?
+
Then I cut the introduction and first paragraph.
 +
=== Aim of this paper ===
 +
'''What are the opportunities of improving documentation for users at a certain point, after install and before successful launch?'''
    
=== Install ===
 
=== Install ===
 +
Imagine you are now reading [[Sweets/Getting started]]
   −
Enter in the Terminal activity, or any other terminal:
+
Introductory paragraph will have "fully" covered distro-non-specific apt-get update.
   −
  wget http://download.sugarlabs.org/sweets/sweets/installer.sh
+
I suggest it might be a good idea to try to fix the level of experience expected of a reader. I suggest a potential reader would have some confidence at the level of http://en.flossmanuals.net/command-line/ch014_multiple-files/ . Do others think a lower level is reasonable? - define.
   −
sh installer.sh
+
Then "packagekit" and issues, then download and run script "installer.sh"
   −
Relogin from X session to take into account the new PATH environment variable value.
+
Then, "After installing PackageKit, you need to restart the DBus system bus." or "Relogin from X session"
 +
: Minor issue 1. a) "Restart the machine" seems clumsy. b) distro-non-specific instructions I guess are too difficult. It might be nice to include, say, the best available outside tutorial, even if only to demonstrate good practice?
   −
Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].
+
''Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].''
    +
:Issue 2. This idea needs dealing with at an appropriate level. Is this an alternative for our reader? Under what conditions would the reader start on this method? Or is it a "more advanced method"?
 
=== Upgrade ===
 
=== Upgrade ===
   Line 27: Line 32:     
  sweets upgrade
 
  sweets upgrade
 +
 +
You should expect a positive response. An example of a positive response is
 +
-- No need in upgrading
 +
or
 +
insert wording generated by successful upgrade.
 +
 +
If you run into difficulties, Sweets contains a --help file. You get it with the command:
 +
 +
sweets -h
 +
 +
The file is displayed in your terminal, you get out of the file by pressing "q" for quit.
 +
 
==== What Sugar to launch ====
 
==== What Sugar to launch ====
   Line 34: Line 51:  
* {{Code|dextrose/sugar}}, for Sugar based on [[Dextrose]].
 
* {{Code|dextrose/sugar}}, for Sugar based on [[Dextrose]].
   −
Both Sugars can be used in the same way. This guide uses {{Code|dextrose/sugar}}.
+
The terms we use are currently defined here: [[Platform_Team/Guide/Sweets_Usage#Search]].
 +
 
 +
The '''name''' of one available sweet (alternate usage ''<SWEET>'' ) is sdk/sugar.
 +
 
 +
Another's '''name''' (alternate usage ''<SWEET>'') is dextrose/sugar.
 +
: These lines aim to draw attention a perceived difficulty in nomenclature. Improved wording welcome.
 +
 
 +
<s>Both Sugars can be used in the same way. This guide uses {{Code|dextrose/sugar}} ... and may use {{Code|sdk/sugar}}</s>
    
== Usage ==
 
== Usage ==
687

edits