Logged-In As
ACCOUNT
Not Logged In
Version the documentation The NetBSD Project
Status: Closed Time to complete: 72 hrs Mentors: Aleksej Saushev, Julian Coleman, Julian Fagir Tags: wiki, system

For the final goal to ship documentation together with an operating system, you have to think about versioning documentation.

There is no use in updating information such that the documentation does not apply to the installed system anymore, but on the other hand it would be nice to update and uprade the documentation on a running system.

Which kind of information is available in NetBSD? How could you version it, what is the effort? How much information in NetBSD must be versionated, and how often are things updated?

In this task, you have to research these questions, and propose technical ways how to distribute documentation in that way (assumed there is a format which makes this possible). You should write a paper at least one page long after this task concluding your results. 

Uploaded Work
File name/URL File size Date submitted
Version The Documentation.docx 18.8 KB December 01 2012 12:07 UTC
version the documentation.txt 3.1 KB December 02 2012 03:39 UTC
Comments
Monika on November 28 2012 23:44 UTC Task Claimed

I would like to work on this task.

Radoslaw Kujawa on November 29 2012 00:12 UTC Task Assigned

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

Radoslaw Kujawa on November 29 2012 11:58 UTC Re: Task Claimed

Hello, how is it going? Do you already have some ideas how to do it? If you have any questions you can ask here or join #netbsd-code on irc.freenode.net.

Monika on December 1 2012 12:08 UTC Ready for review

The work on this task is ready to be reviewed.

Radoslaw Kujawa on December 1 2012 12:28 UTC Re: Ready for review

Please, avoid sending papers in any format that requires special handling. Convert your paper to plain text (or eventually HTML).


 

Radoslaw Kujawa on December 1 2012 12:29 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.

Monika on December 1 2012 12:32 UTC Ready for review

The work on this task is ready to be reviewed.

Monika on December 1 2012 12:32 UTC Claim Removed

The claim on this task has been removed, someone else can claim it now.

Julian Fagir on December 1 2012 20:07 UTC The work was fine

Why did you remove the claim? I just reviewed the docx (please use another format! Most of us cannot properly read it, it is Microsoft-only), and it looks fine.


As this task was about writing one or more pages, your submission would be ok. You just have to reclaim the task.

Monika on December 1 2012 21:23 UTC Task Claimed

I would like to work on this task.

Monika on December 1 2012 21:24 UTC Sorry!

When I was told it needed more work, I wasn't sure what I had to add. What format should I use, for future reference?

Julian Fagir on December 1 2012 21:46 UTC Re: Sorry!

You shoud just paste it in a txt-file.


Just take the text and paste it into notepad, then save it as a .txt.

Aleksej Saushev on December 1 2012 22:40 UTC Task Assigned

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

Monika on December 2 2012 03:41 UTC Ready for review

The work on this task is ready to be reviewed.

Julian Fagir on December 2 2012 08:52 UTC Fine

Yep, this is fine now. Thank you!

Julian Fagir on December 2 2012 08:52 UTC Task Closed

Congratulations, this task has been completed successfully.

Monika on December 2 2012 11:12 UTC Great

Thanks so much!

Julian Fagir on December 2 2012 16:42 UTC Maybe another task for you?

Btw, as you showed interest in the conceptual documentation tasks, and delivered good work, would you like to take up this task? http://www.google-melange.com/gci/task/view/google/gci2012/7998202

Monika on December 3 2012 04:44 UTC Thanks

Looks great, I'll definitely have a go at it soon!