Programming section should be removed from system docs

Bug #414035 reported by Phil Bull on 2009-08-15
This bug affects 1 person
Affects Status Importance Assigned to Milestone
ubuntu-docs (Ubuntu)
Connor Imes

Bug Description

Binary package hint: ubuntu-docs

The Programming section should be removed from the system documentation because it's not a suitable end user help topic. A better place to document programming is on the community help wiki.

The section should be reviewed and anything useful should be merged into the wiki before it is deleted.

Mailing list discussion:

Connor Imes (ckimes) wrote :

The programming pages on the wiki currently need some re-organization before this can be completed. That re-org should probably be worked with the Signpost project as well. Any ideas on how best to re-org those pages and integrate this system doc material in with it?

Changed in ubuntu-docs (Ubuntu):
status: New → Confirmed
Phil Bull (philbull) on 2009-08-16
Changed in ubuntu-docs (Ubuntu):
importance: Undecided → Low

For clarification, is the programming section in the system documentation is under Advanced Topics > Writing Your Own Programs? If so, I've had a look and found places in the community wiki for most of it. Not sure what ideas exist regarding reorganisation or if any work has been done already. If required, I can provide a plan for merging articles.

Phil Bull (philbull) wrote :

Hi Yevgeniy,

Yes, that's the right section. It would be great if you could help out with the reorganisation! Someone else is already looking at the wiki (, so maybe you'd like to get in touch with him, perhaps via the ubuntu-doc mailing list? That's probably the best place to do any planning, and we'd definitely be interested in your proposed plan for merging the articles.


Connor Imes (ckimes) on 2009-11-25
Changed in ubuntu-docs (Ubuntu):
assignee: nobody → Connor Imes (rocket2dmn)
status: Confirmed → In Progress
Connor Imes (ckimes) wrote :

Matthew (or other committers), can I please get a review of this change as it is rather large. I have removed:
 - the entire programming directory,
 - the reference to the programming section from advanced-topics,
 - the listing in libs/shipped-docs,
 - references in scripts/
I did not touch the broken-translations file which has a mention of it.

If approved, I will commit this change. Thanks.

Matthew East (mdke) wrote :

Connor - the patch looks fine to me, thanks! If you're satisfied the material has been merged into the wiki (I haven't checked) then please go ahead.

You can remove the mention in the broken-translations file too.

Connor Imes (ckimes) wrote :

Programming docs have been removed in Lucid development branch, revision 388.

Changed in ubuntu-docs (Ubuntu):
status: In Progress → Fix Committed
Launchpad Janitor (janitor) wrote :
Download full text (4.3 KiB)

This bug was fixed in the package ubuntu-docs - 10.04.1

ubuntu-docs (10.04.1) lucid; urgency=low

  * First upload for lucid
  * General:
    - Refresh pot files
    - Changed 'Text Editor' to 'gedit Text Editor' LP: #442417 (Connor Imes)
  * Advanced-topics:
    - Added link in advanced-topics to a description about Users and Groups in
      Debian systems. LP: #145055 (Connor Imes)
  * Hardware:
    - Added mention of ext4 to hardware.xml and changed the mentioning of the
      default filesystem in Ubuntu from ext3 to ext4 LP #449667 (Connor Imes)
    - Removed subsection in hardware about quirk-checker script - link was
      broken, script is outdated LP: #461158 (Connor Imes)
  * Keeping-safe:
    - Updating instructions for automatic login for new GDM LP: #442676
     (Dean Sas)
    - String adjustment (period inside of a quote tag), Scott Shields,
      LP: #496885
  * Internet:
    - Changes remaining mention of flashplugin-nonfree to flashplugin-installer
      in web-apps.xml LP: #444546 (Connor Imes)
    - Change some <guimenu> tags to <guimenuitem> tags in web-apps.xml to show
      arrows in HTML documentation instead of + signs LP: #453512 (Connor Imes)
    - Removed reference to network-manager radio buttons, as radio buttons
      aren't used in this version of NM for wired networks (Jim Campbell)
    - Aligned similar strings in 'internet' section to benefit translators;
      some small adjustments. LP: #460360 (Connor Imes)
  * Musicvideophotos:
    - Fixed apturl for mtp-tools package in music.xml LP #452262 (Connor Imes)
    - Improve ipod section, patch by Michael Fitzhugh. LP: #370085
  * Printing:
    - Updated printer setup directions in printing section LP: #435510
      (Connor Imes)
    - Fix scanning typo. Patch by Shane Fagan LP: #447250
  * Programming:
    - Removed entire programming section LP: #414035 (Connor Imes)
  * Serverguide:
    - Adjusted wording in serverguide package-management file to more
      clearly describe apticron. LP: #473280 (Connor Imes)
    - Updated LDAP section for changes to the Jaunty package.
      Fixes LP: #475492, LP: #459403, LP: #463684 (Adam Sommer)
    - In OpenSSH section, .ssh/authorized_keys permissions should be
      600, not 644 LP: #491159 (Connor Imes)
    - Replaced description of ebox Log Observer in serverguide with a real
      description of the event's purpose LP: #405926 (Connor Imes)
    - Fixed IP example in serverguide's postfix configuration section
      LP: #495202 (Connor Imes)
    - Include 'auto eth1' in interfaces file for static IP configuration
      LP: #441802 (Connor Imes)
    - Fix for disabling Control-Alt-Delete in serverguide. Scott Shields,
      LP: #496465
    - Typo fix, Scott Shields, LP: #497867
    - PostgreSQL setup fix for config file pg_hba.conf, Scott Shields,
      LP: #492286
    - Misc fixes in windows-networking section. Vikram Dhillon, LP: #462607
    - Changes to RAID installation section LP: #428036, LP: #462719
      (Connor Imes)
    - Fixes and adjustments to web-servers LP: #462621 (Connor Imes)
  * Switching:
    - Replaced Pidgin with Empathy in applications-equivalents
      LP: #490980 (Connor Ime...


Changed in ubuntu-docs (Ubuntu):
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers