From Teaching Open Source

Draft The contents of this page are subject to change. Please leave suggestions inline or on the discussion page.

Contents 1 Relevant Discussion 2 Objectives 3 Wiki links 3.1 Existing 3.2 New 3.3 Result

It has been agreed that we will put the Textbook and its planning documents under version control.

[edit] Relevant Discussion

From the Mailing List Archive:

• Mail subject line: [TOS] [[Practical OSS Exploration textbook]]
  • NeoPhyte_Rep Thu Aug 19 13:56:04 EDT 2010
  • Chris Tyler Sat Aug 21 21:17:22 EDT 2010

[edit] Objectives

1. The Textbook will be titled "Practical Open Source Software Exploration".
   1. Subtitle: "How to be Productively Lost, the Open Source Way".
   2. The Wiki title base will be "Practical OSS Exploration".
2. There will be revisions referred to as:
   1. Previous - will have a Version.Revision.Modification number such as 0.8.0.
   2. Stable - Wiki abbreviated as "stab" and implemented as a redirection.
   3. Development - Wiki abbreviated as "devl" and implemented as a redirection.

[edit] Wiki links

[edit] Existing

This attempts to show how the Wiki pages are currently internally linked. Please note the two locations for all the 0.8 alternate formats. Also note they are currently filed outside the TeachingOpenSource.org domain.

• Textbook Project
  • Textbook Roadmap
    • Textbook Release 0.8
      • 0.8 HTML
      • 0.8 HTML single-page
      • 0.8 PDF
      • Chapters at a particular revision level:
        • Foreword
        • Introduction to Free and Open Source Software
        • The Lay of the Land
        • Getting the Code
        • Building the Code
        • Debugging the Code
        • Fixing the Code
        • Explaining the Code: the Art of Documentation
        • Release Early, Release Often
        • Instructor Guide
    • 0.8 HTML
    • 0.8 HTML single-page
    • 0.8 PDF
    • Subversion source with DocBook XML
    • Publican brand SRPM and RPM
    • Practical OSS Exploration textbook 0.8.1 planning
    • Chapters under revision:
      • Foreword
      • Introduction to Free and Open Source Software
      • The Lay of the Land
      • Getting the Code
      • Building the Code
      • Debugging the Code
      • Fixing the Code
      • Explaining the Code
      • Release Early, Release Often
      • Instructor Guide
      • Glossary of Terms
• Practical OSS Exploration textbook is a transclusion of Textbook Release 0.8
• Textbook 0.9 planning notes Please note there are no links to this Wiki page.
• Textbook redirects to Practical OSS Exploration textbook
• Textbook Latest Release
• Textbook Redirect redirects to Textbook Release 0.8
• Textbook editing processes redirects to Practical OSS Exploration editing processes
• Practical OSS Exploration editing processes
• Textbook wiki2xml conversion sprint 20100326
  • Textbook Roadmap#Textbook Roadmap Please note there is no Textbook Roadmap section in Textbook Roadmap.
  • Textbook Release 0.8
  • http://teachingopensource.org/repos/textbook This is a Subversion repository.
• Textbook writing rules of engagement This needs to be linked somewhere into the hierarchy.

[edit] New

Template:P_OSS_E will contain "Practical Open Source Software Exploration". I think I can make it optionally generate "Practical OSS Exploration", also.

[edit] Result

This attempts to show how the Wiki pages are to be internally linked.

• Textbook Project This will contain links to each Roadmap of each textbook identified as needed and the wiki pages that guide the project's execution by a community.
  • Textbook writing rules of engagement This explains how to use a wiki in a multi-author, multi-threaded revision project.
  • P_OSS_E:Book stable will redirect to P_OSS_E:Book 0.8.0
  • P_OSS_E:Roadmap stable will be empty until Version 0.8.1 becomes the stable version or could redirect to P_OSS_E:Roadmap:0.8.0, which, in turn could redirect to the Textbook Roadmap version that was in use when Textbook Revision 0.8 was released.
  • P_OSS_E:Roadmap development will redirect to P_OSS_E:Roadmap 0.8.1
  • P_OSS_E:Editing processes
• Practical OSS Exploration editing processes redirects to P_OSS_E:Editing processes
• Textbook editing processes redirects to P_OSS_E:Editing processes
• Textbook redirects to P_OSS_E:Book stable which redirects to P_OSS_E:Book 0.8.0
• Practical OSS Exploration textbook redirects to P_OSS_E:Book stable which redirects to P_OSS_E:Book 0.8.0
• Textbook Latest Release redirects to P_OSS_E:Book stable which redirects to P_OSS_E:Book 0.8.0
• Textbook Redirect redirects to P_OSS_E:Book stable which redirects to P_OSS_E:Book 0.8.0
• P_OSS_E:Book:0.8.0
  • The complete book in other data formats. Note they are now in the TeachingOpenSource.org domain:
    • P_OSS_E 0.8.0 HTML
    • P_OSS_E 0.8.0 HTML single-page
    • P_OSS_E 0.8.0 PDF
    • Subversion source with DocBook XML
    • Publican brand SRPM and RPM
  • P_OSS_E:Book:0.8.0:wiki2xml conversion sprint 20100326
    • Textbook Roadmap#Textbook Roadmap Please note there is no Textbook Roadmap section in Textbook Roadmap.
    • P_OSS_E:Book:0.8.0
    • http://teachingopensource.org/repos/textbook This is a Subversion repository.
  • Chapters at a particular revision level: Perhaps there should be a P_OSS_E:0.8.0: based redirection link to each of these. It would make it easier to include the link in other documents.
    • Foreword
    • Introduction to Free and Open Source Software
    • The Lay of the Land
    • Getting the Code
    • Building the Code
    • Debugging the Code
    • Fixing the Code
    • Explaining the Code: the Art of Documentation
    • Release Early, Release Often
    • Instructor Guide
• P_OSS_E:Roadmap 0.8.1 Basic objectives and possible contributors for this cycle.
  • P_OSS_E:Planning 0.8.1 Specific objectives, dates, and contributors' volunteered commitments for this cycle.
  • P_OSS_E:Book 0.8.1
    • Chapters under revision:
      • P_OSS_E:0.8.1:Foreword
      • P_OSS_E:0.8.1:Introduction to Free and Open Source Software
      • P_OSS_E:0.8.1:The Lay of the Land
      • P_OSS_E:0.8.1:Getting the Code
      • P_OSS_E:0.8.1:Building the Code
      • P_OSS_E:0.8.1:Debugging the Code
      • P_OSS_E:0.8.1:Fixing the Code
      • P_OSS_E:0.8.1:Explaining the Code
      • P_OSS_E:0.8.1:Release Early, Release Often
      • P_OSS_E:0.8.1:Instructor Guide
      • P_OSS_E:0.8.1:Glossary of Terms
• P_OSS_E:Roadmap 0.9.0 Basic objectives and possible contributors for this cycle.
  • P_OSS_E:Planning 0.9.0 Specific objectives, dates, and contributors' volunteered commitments for this cycle.
  • P_OSS_E:Book 0.9.0
    • Chapters under revision:
      • P_OSS_E:0.9.0:Foreword
      • P_OSS_E:0.9.0:Introduction to Free and Open Source Software
      • P_OSS_E:0.9.0:The Lay of the Land
      • P_OSS_E:0.9.0:Getting the Code
      • P_OSS_E:0.9.0:Building the Code
      • P_OSS_E:0.9.0:Debugging the Code
      • P_OSS_E:0.9.0:Fixing the Code
      • P_OSS_E:0.9.0:Explaining the Code
      • P_OSS_E:0.9.0:Release Early, Release Often
      • P_OSS_E:0.9.0:Instructor Guide
      • P_OSS_E:0.9.0:Glossary of Terms
    • Proposed chapters:
      • P_OSS_E:0.9.0:Being Productively Lost
      • P_OSS_E:0.9.0:History of Open Source
      • P_OSS_E:0.9.0:Community Cultures
      • P_OSS_E:0.9.0:Open Communities and Diversity
      • P_OSS_E:0.9.0:Licensing the Code
      • P_OSS_E:0.9.0:Threats and Risks Analysis for Open Source
      • P_OSS_E:0.9.0:Open for Business
      • P_OSS_E:0.9.0:Practicing the Open Source Way
      • P_OSS_E:0.9.0:Requirements for the Code
      • P_OSS_E:0.9.0:Designing the Code
      • P_OSS_E:0.9.0:Testing the Code