Logged-In As
ACCOUNT
Not Logged In
Check the FreeBSD handbook's bibliography appendix B for broken links/references FreeBSD
Status: Closed Time to complete: 48 hrs Mentors: Gavin Atkinson Tags: DocBook, links, documentation, SGML, 404, FreeBSD

Description of task

The FreeBSD handbook's bibliography appendix B contains many links to external sites: http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/bibliography.html Some of these sites might not be available anymore, have moved or may contain new information not related to FreeBSD. In order to keep that section up to date, the objective of this task is to go through the whole appendix B and check whether the links are still correct and point to the source mentioned in the text. Broken links should be reported to your mentor. If you find other (updated) links that contain the information, update the broken links accordingly. If the information the link pointed to does not exist anymore, discuss with your mentor whether just the link or the whole information should be removed.

Task requires:


A FreeBSD system (in a VirtualBox Virtual Machine) installed on your computer. 
Knowledge of the documentation guidelines for the FreeBSD project: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/
Check out a copy of the documentation tree from the documentation repository to get the source code for the chapter
Knowledge on how to research information on the internet
Thorough work style

Uploaded Work
File name/URL File size Date submitted
Bib.docx 41.7 KB November 21 2011 22:36 UTC
BibliographyGCI.txt 29.7 KB November 24 2011 07:54 UTC
Bibliography.sgml 29.7 KB November 24 2011 07:55 UTC
Comments
Anikan on November 21 2011 14:45 UTC Task Claimed

I would like to work on this task.

Gavin Atkinson on November 21 2011 15:49 UTC Task Assigned

This task has been assigned to Anikan. You have 48 hours to complete this task, good luck!

Anikan on November 21 2011 19:16 UTC Nearly Done

I've checked all of the links, and found many changes.
For most books, I found links for the publisher and for a description of the book.
I'm just not sure how to submit it.

I basically copied the bibliography and used the comment system to show discrepancies or new links in a word doc (Microsoft Word 2007). Should I just upload that, or do something else?

Anikan on November 22 2011 15:54 UTC Ready for review

The work on this task is ready to be reviewed.

Gavin Atkinson on November 22 2011 16:31 UTC Providing diffs

Hi,

Firstly, thanks for taking this task, the work you have done so far looks great.

The preferred method for submitting your work is by providing diffs against the source code for the documentation.

There are instructions at http://wiki.freebsd.org/GoogleCodeIn/GettingTheSource which cover getting the source, making and testing your changes, and generating a diff in a format that can be submitted.

Once you have downloaded the source, the source for the bibliography chapter is
/usr/doc/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml . Information relating to exactly how to write FreeBSD documentation is at http://www.freebsd.org/doc/en/books/fdp-primer/ should it not be clear how to (for example) create links in the documentation.

Hope that helps. Feel free to ask more questions if anything is unclear - this is the first year that we've participated in GCIN, so it's a bit of a learning curve for us too just what documentation we need to produce...

Thanks,

Gavin

Gavin Atkinson on November 22 2011 16:34 UTC Apologies

Sorry, I hadn't realised that my formatting would be stripped out of that message. Hopefully this will be formatted better.

Firstly, thanks for taking this task, the work you have done so far looks great.

The preferred method for submitting your work is by providing diffs against the source code for the documentation.

There are instructions at http://wiki.freebsd.org/GoogleCodeIn/GettingTheSource which cover getting the source, making and testing your changes, and generating a diff in a format that can be submitted.

Once you have downloaded the source, the source for the bibliography chapter is
/usr/doc/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml . Information relating to exactly how to write FreeBSD documentation is at http://www.freebsd.org/doc/en/books/fdp-primer/should it not be clear how to (for example) create links in the documentation.

Hope that helps. Feel free to ask more questions if anything is unclear - this is the first year that we've participated in GCIN, so it's a bit of a learning curve for us too just what documentation we need to produce...

Thanks,

Gavin

Gavin Atkinson on November 22 2011 23:55 UTC Task Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Gavin Atkinson on November 22 2011 23:55 UTC Deadline extended

The deadline of the task has been extended with 1 days and 0 hours.

Gavin Atkinson on November 22 2011 23:58 UTC Task extension

Hi,

I've re-opened the task, to enable you to submit the (great) work you have done as a diff against the source. Hopefully the instructions I've provided earlier will assist you in doing this. I've also extended the deadline by another day, as the initial instructions weren't really clear enough about how to submit the work etc.

Please do contact me if you have any other questions.

Gavin

Anikan on November 23 2011 04:39 UTC Another way?

Is there a way to get all of the files without using freeBSD? I tried to install it, but all I get is an error.

Gavin Atkinson on November 23 2011 11:58 UTC Another way

Hi,

I'm sorry to hear that you are having problems installing FreeBSD. We're hoping to have a pre-made VirtualBox image for students to use but that won't be ready for another couple of days, so instead I'd suggest you:

Download the source code for the page from:


http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/doc/en_US.ISO8859-1/books/handbook/bibliography/chapter.sgml?rev=1.89;content-type=text%2Fplain

Make all of your changes to the file. It should be relatively simple to follow the format of the file by looking at how other entries are written, and how the resulting web page appears.

Once you are happy you have done all of the work, submit the entire file. If you want me to review it before you submit it I'm happy to, please email it to me gavin@FreeBSD.org

As you are unable to install FreeBSD for some reason, there's no easy way that you can test your changes. As this is an exceptional circumstance, I'll accept your submission without testing and won't mark you down for this at all - but do try to be careful with the edits you make in the hope that your work will be mostly correct when submitted :)

Additionally, if you have time, I would be interested in knowing what issue you had with installing FreeBSD. Please feel free to finish this task first, but if you can then please drop me an email with a few details of the issues you saw (i.e. what was the error message, what hardware are you trying to install onto or what VM software are you using, etc).

Thanks!

Gavin

Anikan on November 24 2011 07:56 UTC Ready for review

The work on this task is ready to be reviewed.

Gavin Atkinson on November 24 2011 10:29 UTC Excellent!

Hi,

I've just reviewed your work, and it looks excellent. You've paid great attention to detail, and have managed to produce work which is of a high standard. This work is excellent, thanks! I shall mark this task as closed.

Thanks again,

Gavin

Gavin Atkinson on November 24 2011 10:29 UTC Task Closed

Congratulations, this task has been completed successfully.