Test Installation Instructions

From Foss2Serve
(Difference between revisions)
Jump to: navigation, search
(Created page with "__NOTOC__ {| border="1" |- |'''Title''' || Test the Installation Instructions for a Project |- |'''Overview''' || The goal of this activity is to test the correctness an...")
 
 
(5 intermediate revisions by 3 users not shown)
Line 12: Line 12:
  
 
=== Background: ===
 
=== Background: ===
All open source projects want new users. However, the download and install instructions for many projects are either incomplete or out of date.  Testing the download and install directions and providing feedback to the community would be  
+
All open source projects want new users. However, the download and install instructions for many projects are either incomplete or out of date.  Testing the download and install directions and providing feedback to the community would be extremely helpful to the community.
  
 
=== Directions: ===
 
=== Directions: ===
 +
# Find a project of interest. There is a list at the end of this activity.
 +
# Search the project documentation to identify the location of the download and install directions. These instructions may be found on the project web site or within the code itself, perhaps in a README file.
 +
# Follow the download instructions, taking note of any problems or issues that you found.
 +
# Follow the installation instructions, taking note of any problems or issues that you found.
  
 
=== Deliverables: ===
 
=== Deliverables: ===
 +
A discussion of what you found which should include:
 +
# A description of the operating system and environment within which you performed the download and install
 +
# An itemized list of the issues that you found when trying to download and install the product.
 +
# A list of what could be done to improve the download and install instructions.
 +
'''Variation 1:''' Repeat the above for the development environment.
 +
 +
'''Variation 2:''' Use the project's "Getting Started" guide, if such exists.  If it doesn't exist, creating a Getting Started guide would be a great way for a class to contribute back to a project.
  
 
=== Assessment: ===
 
=== Assessment: ===
  
 
=== Comments: ===
 
=== Comments: ===
 +
It is strongly recommended that you, as the instructor, have installed the software environment yourself so that you can predict any issues that the students might have.  You also may need to have software installed on lab machines or controlled environments, so check on this before your class.
 +
 
The download and installation instructions for projects may be located on the project web site but may also be loaded within the actual code. Therefore, learners may need to find the code repo and do some searching there. Install dependencies may complicate the download and install.
 
The download and installation instructions for projects may be located on the project web site but may also be loaded within the actual code. Therefore, learners may need to find the code repo and do some searching there. Install dependencies may complicate the download and install.
 +
 +
 +
 +
Some good projects you might choose to work with:
 +
{| border="1"
 +
|-
 +
| '''Project''' || '''Description''' || '''Requirements'''
 +
|-
 +
| [https://wiki.gnome.org/action/show/Projects/MouseTrap?action=show&redirect=MouseTrap MouseTrap] || GNOME Accessibility project that uses a web cam to track user head movement and move the cursor accordingly || Needs a webcam
 +
|-
 +
| [http://openmrs.org/ OpenMRS] || Leading FOSS electronic medical record system platform || None
 +
|-
 +
| [http://www.ushahidi.com/ Ushahidi] || Data management system that uses crowdsourced data || None
 +
|}
  
 
=== Additional Information: ===
 
=== Additional Information: ===
Line 45: Line 72:
  
 
=== Suggestions for the Open Source Project: ===
 
=== Suggestions for the Open Source Project: ===
 +
Students will have more success with this activity if your "Download and Installation" documents are correct :-)
 +
  
 
--------------------
 
--------------------
Line 55: Line 84:
 
[[Category: Documentation]]
 
[[Category: Documentation]]
 
[[Category: Quality and Testing]]
 
[[Category: Quality and Testing]]
 +
[[Category: CS Principles]]
 +
[[Category: Good Draft]]

Latest revision as of 17:47, 8 March 2017

Title Test the Installation Instructions for a Project
Overview The goal of this activity is to test the correctness and completeness of the download and installation instructions for a FOSS project.
Prerequisite Knowledge Some understanding of how to download and install software.
Learning Objectives Learners will understand where to look for download and install instructions for a FOSS project, understand the features of download and install instructions, be able to follow and assess download and install instructions.

Background:

All open source projects want new users. However, the download and install instructions for many projects are either incomplete or out of date. Testing the download and install directions and providing feedback to the community would be extremely helpful to the community.

Directions:

  1. Find a project of interest. There is a list at the end of this activity.
  2. Search the project documentation to identify the location of the download and install directions. These instructions may be found on the project web site or within the code itself, perhaps in a README file.
  3. Follow the download instructions, taking note of any problems or issues that you found.
  4. Follow the installation instructions, taking note of any problems or issues that you found.

Deliverables:

A discussion of what you found which should include:

  1. A description of the operating system and environment within which you performed the download and install
  2. An itemized list of the issues that you found when trying to download and install the product.
  3. A list of what could be done to improve the download and install instructions.

Variation 1: Repeat the above for the development environment.

Variation 2: Use the project's "Getting Started" guide, if such exists. If it doesn't exist, creating a Getting Started guide would be a great way for a class to contribute back to a project.

Assessment:

Comments:

It is strongly recommended that you, as the instructor, have installed the software environment yourself so that you can predict any issues that the students might have. You also may need to have software installed on lab machines or controlled environments, so check on this before your class.

The download and installation instructions for projects may be located on the project web site but may also be loaded within the actual code. Therefore, learners may need to find the code repo and do some searching there. Install dependencies may complicate the download and install.


Some good projects you might choose to work with:

Project Description Requirements
MouseTrap GNOME Accessibility project that uses a web cam to track user head movement and move the cursor accordingly Needs a webcam
OpenMRS Leading FOSS electronic medical record system platform None
Ushahidi Data management system that uses crowdsourced data None

Additional Information:

Knowledge Area/Knowledge Unit
Topic
Level of Difficulty Easy/Moderate
Estimated Time to Completion 60 - 120 minutes
Materials/Environment
Author Heidi Ellis
Source
License CCSA


Suggestions for the Open Source Project:

Students will have more success with this activity if your "Download and Installation" documents are correct :-)



This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License

CC license.png

Personal tools
Namespaces
Variants
Actions
Events
Learning Resources
HFOSS Projects
Evaluation
Navigation
Toolbox