Maintaining activity web information: Difference between revisions

From OLPC
Jump to navigation Jump to search
(→‎Software update: add table to this section)
(lots of updates)
Line 3: Line 3:
# Develop your activity
# Develop your activity
# Host it on sugarlabs.org
# Host it on sugarlabs.org
# Create a web page for it here in [[:Category:Activities]]
# Create a web page for it here on {{SERVERNAME}}
#* in [[:Category:Activities]]
#* with semantic information from 'Edit with form]'
#* with semantic information from 'Edit with form]'
#* if you like, with the attractive
#* if you like, with the attractive "OBX badges"
# Create a little fragment called "Activities/''My Name'' (latest)" for it and transclude this in [[Activities/All]]
# Create a little fragment called "Activities/''My Thingy'' (latest)" for it and transclude this in [[Activities/All]] using <nowiki>{{:Activities/''My Thingy''}}</nowiki>.
# Should it be invited to be a part of an [[Activity groups|Activity group]], create similar fragments "Activities/8.2/''My Name'' (latest)" and someone else will transclude this in the appropriate page such as [[Activities/G1G1/8.2]], [[Activities/G1G1]], etc.
# Should it be invited to be a part of an [[Activity groups|Activity group]], create similar fragments "Activities/8.2/''My Thingy'' (latest)" and someone else will transclude this in the appropriate page such as [[Activities/G1G1/8.2]], [[Activities/G1G1]], etc.
# Once the latest version no longer works for a particular release or stream, create a separate fragment for that, such as "Activities/8.2/''My Name'' (8.2)"
# Once the latest version no longer works for a particular release or stream, create a separate fragment for that, such as "Activities/8.2/''My Thingy'' (8.2)"


== Your activity's web page ==
== Your activity's web page ==
Alas [[Creating an activity]] and its buttons seems out-of-date. ''Do not use this.'' Instead, copy what you understand from an existing activity page. ''TODO: An acceptable template''
Alas [[Creating an activity]] and its buttons seems out-of-date. ''Do not use this.'' Instead, copy what you understand from an existing activity's page. ''TODO: Need to create an acceptable simple template''


; It should be in [[:Category:Activities]]
; It should be in [[:Category:Activities]]
: Otherwise no one will find it!


; It must have semantic information in it.
; It must have semantic information in it.
: Pages in [[:Category:Activities]] get an '[Edit with form]' tab button, you should click this and fill in information about your activity. This will ensure your activity will show up in pages like
: Pages in [[:Category:Activities]] get an '[Edit with form]' tab button, you should click this and fill in information about your activity. This will ensure your activity will show up in pages like [[Activity queries]].
* It should have screenshots
* It should have screenshots



[[Software update]] can automatically update


== Software update ==
== Software update ==
The [[Software update]] [[Sugar control panel]] will consult a series of web pages to find the most recent version for the release the laptop is running, and will install or update to that version.
The [[Software update]] [[Sugar Control Panel]] will consult a series of web pages to find the most recent version for the release the laptop is running, and will install or update to that version.
This requires that
This requires that
# the right web pages exist
# the right web pages exist
Line 31: Line 29:
=== Your own activity ===
=== Your own activity ===


You can mention a URL to contact in the <tt>activity.info</tt> file, see [[Activity_bundles]].
You can mention a URL to contact in its <tt>activity.info</tt> file, see [[Activity_bundles]].
That can be a fragment for it on the web site.


=== Activity groups ===
=== Activity groups ===
Line 43: Line 42:
Here seems to be the way activities in the activity groups are set up.
Here seems to be the way activities in the activity groups are set up.
They all use the template {{tl|Activity-oneline}}
They all use the template {{tl|Activity-oneline}}

{|class=wikitable
{|class=wikitable


Line 49: Line 49:
! Sample
! Sample
|-
|-
| Activities/''My Activity'' (latest)
| Activities/''My Thingy'' (latest)
| This is the latest version of your activity available. It should match the primary information from '[Edit with form]' on your activity's web page.
| This is the latest version of your activity available. It should match the primary information from '[Edit with form]' on your activity's web page.
| [[Activities/Etoys (latest)]]
| [[Activities/Etoys (latest)]]
|-
|-
| Activities/''My Activity'' (8.2)
| Activities/''My Thingy'' (8.2)
| This is version of your activity that works with release [[8.2.0]]. If that version is identical to the latest, then you can make it a <tt>#REDIRECT</tt> page to the latest. The moment your latest version no longer works with 8.2 you need to maintain this separately.
| This is version of your activity that works with release [[8.2.0]]. If that version is identical to the latest, then you can make it a <tt>#REDIRECT</tt> page to the latest. The moment your latest version no longer works with 8.2 you need to maintain this separately.
| [[Activities/Etoys (8.2)]]
| [[Activities/Etoys (8.2)]]
|}
|}


You don't need a fragment for earlier releases than [[8.2.0]] since they did not have the [[Software update]] feature. But you can track these in your activity's web page.
You don't need a fragment for earlier releases than [[8.2.0]] since they did not have the [[Software update]] feature.
You can present these earlier versions on your activity's web page.

== Other bits and pieces ==
Several activities seem to have a page "Activities/''My Thingy''" (with no version in parentheses).
This seems to be unused, and is often a redirect to an unused "Projects/''My Thingy''" using {{tl|Activity-summary}} template (obsolete?!).
''TODO: '''KILL THESE''' ''

== Things to check ==
* The version and bundle URL listed in [[Activities/All]] should match the latest [[Property:Activity version]] and [[Property:Activity bundle]] on the activity's web page (set using '[Edit with form]').

=== If an activity is in an activity group ===
* The activities transcluded into [[Activities/G1G1]] should ''exactly match'' the set of activities with [[Property:Activity group]] set to Activities/G1G1 (set using'[Edit with form]').
Only a release or deployment manager can decide an activity is in an activity group such as G1G1. if it is, then:
* The version and bundle URL listed in [[Activities/G1G1]] should match the latest [[Property:Activity version]] and [[Property:Activity bundle]] on the activity's web page (set using '[Edit with form]').
* The version and bundle URL listed in [[Activities/G1G1/8.2]] should either match that or be an earlier version.



== A better way ==
== A better way ==
There's way too much update here.
There's way too much update here!


See [[Semantic MediaWiki]] for a better approach.
See [[Semantic_MediaWiki#For activities]] and [[Semantic_MediaWiki/Activities]] for a better approach.
* [Edit with form] should produce the [[Activity microformat]] on the activity page
* [Edit with form] should produce the [[Activity microformat]] directly on the activity page
* the [Add another version] button should be separate properties so there's no ambiguity about latest version, latest URL, etc.
* the [Add another] version button should either create NO properties at all, or create separate "'''earlier''' activity version/bundle/software release" properties so there's no ambiguity about what is the latest activity version/bundle URL/software release
** This could be a <nowiki><noinclude</nowiki> fragment.
** This could be a <nowiki><noinclude</nowiki> fragment.
* the OBX badges should fill in with semantic info if present
* the OBX badges should fill in with semantic info if present
* still have to maintain "Activities/''My Thingy'' (8.2)" fragment separately, even though the info is in the activity's web page.
*


[[Category:Developers]]
[[Category:Developers]]

Revision as of 03:03, 6 February 2009


Pencil.png NOTE: The contents of this page are not set in stone, and are subject to change!

This page is a draft in active flux ...
Please leave suggestions on the talk page.

Pencil.png
  1. Develop your activity
  2. Host it on sugarlabs.org
  3. Create a web page for it here on wiki.laptop.org
    • in Category:Activities
    • with semantic information from 'Edit with form]'
    • if you like, with the attractive "OBX badges"
  4. Create a little fragment called "Activities/My Thingy (latest)" for it and transclude this in Activities/All using {{:Activities/''My Thingy''}}.
  5. Should it be invited to be a part of an Activity group, create similar fragments "Activities/8.2/My Thingy (latest)" and someone else will transclude this in the appropriate page such as Activities/G1G1/8.2, Activities/G1G1, etc.
  6. Once the latest version no longer works for a particular release or stream, create a separate fragment for that, such as "Activities/8.2/My Thingy (8.2)"

Your activity's web page

Alas Creating an activity and its buttons seems out-of-date. Do not use this. Instead, copy what you understand from an existing activity's page. TODO: Need to create an acceptable simple template

It should be in Category:Activities
Otherwise no one will find it!
It must have semantic information in it.
Pages in Category:Activities get an '[Edit with form]' tab button, you should click this and fill in information about your activity. This will ensure your activity will show up in pages like Activity queries.
  • It should have screenshots

Software update

The Software update Sugar Control Panel will consult a series of web pages to find the most recent version for the release the laptop is running, and will install or update to that version. This requires that

  1. the right web pages exist
  2. the web pages have the information in the right machine-readable format

Your own activity

You can mention a URL to contact in its activity.info file, see Activity_bundles. That can be a fragment for it on the web site.

Activity groups

Laptops in the G1G1 program (and possibly country deployments) are configured to install a set of activities known as an Activity group.

Do not add your activity to a group, except perhaps Activities/Joyride. The decision as to what activities and collections belong in a group is not yours to make!

Fragments for activities

Here seems to be the way activities in the activity groups are set up. They all use the template {{Activity-oneline}}

Name Description Sample
Activities/My Thingy (latest) This is the latest version of your activity available. It should match the primary information from '[Edit with form]' on your activity's web page. Activities/Etoys (latest)
Activities/My Thingy (8.2) This is version of your activity that works with release 8.2.0. If that version is identical to the latest, then you can make it a #REDIRECT page to the latest. The moment your latest version no longer works with 8.2 you need to maintain this separately. Activities/Etoys (8.2)

You don't need a fragment for earlier releases than 8.2.0 since they did not have the Software update feature. You can present these earlier versions on your activity's web page.

Other bits and pieces

Several activities seem to have a page "Activities/My Thingy" (with no version in parentheses). This seems to be unused, and is often a redirect to an unused "Projects/My Thingy" using {{Activity-summary}} template (obsolete?!). TODO: KILL THESE

Things to check

If an activity is in an activity group

Only a release or deployment manager can decide an activity is in an activity group such as G1G1. if it is, then:


A better way

There's way too much update here!

See Semantic_MediaWiki#For activities and Semantic_MediaWiki/Activities for a better approach.

  • [Edit with form] should produce the Activity microformat directly on the activity page
  • the [Add another] version button should either create NO properties at all, or create separate "earlier activity version/bundle/software release" properties so there's no ambiguity about what is the latest activity version/bundle URL/software release
    • This could be a <noinclude fragment.
  • the OBX badges should fill in with semantic info if present
  • still have to maintain "Activities/My Thingy (8.2)" fragment separately, even though the info is in the activity's web page.