Write an article soliciting a Windows platform maintainerBRL-CAD
Status: ClosedTime to complete: 72 hrs Mentors: SeanTags:

BRL-CAD runs on a number of platforms and distributes releases many times a year. Creating a release for any particular binary platform, like Windows or Mac OS X or Linux, is delegated to a ''release maintainer''. We currently have maintainers for a number of platforms but do not have one for Windows. Basically, it's a volunteer job, it's a lot of work, but not very hard and very rewarding. There are thousands of binary downloads every month, so lots of people benefit from a maintainer's efforts.

This task involves writing a brief solicitation article announcing our interest for a maintainer, describing the responsibilities involved, and telling them how to take up this responsibility. Come talk to us on IRC for more specific details.

Resources:

  • http://svn.code.sf.net/p/brlcad/code/brlcad/trunk/HACKING (See the release section near the bottom to see what maintainers do)

Add the article to http://brlcad.org/wiki/Community_Publication_Portal

Uploaded Work
File name/URLFile sizeDate submitted
Software Maintainer - BRL CAD.docx31.1 KBNovember 20 2013 19:23 UTC
Software Maintainer - BRL CAD (Update).docx32.4 KBNovember 21 2013 17:40 UTC
Comments
Gary-Austin Moraleson November 18 2013 17:13 UTCTask Claimed

I would like to work on this task.

Gary-Austin Moraleson November 18 2013 17:17 UTCClaim Removed

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

Alexon November 18 2013 17:52 UTCTask Claimed

I would like to work on this task.

Sean on November 18 2013 18:05 UTCTask Assigned

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

Alexon November 18 2013 19:03 UTCFind out about a maintainer

Im having trouble gaining a full understanding of what a 'maintainer' is. So far i have clicked on the link presented and have read through the binary release section on the document; from what i read it seems like the maintainer just names the binary release. 


Im basically asking for more detail on the maintainers job and responsibility or a page where i can learn about this.

Sean on November 18 2013 21:43 UTCmaintainer

http://en.wikipedia.org/wiki/Software_maintainer


Basically, they're a person willing to support creating the release binaries for a given platform (like Windows or Linux or Mac or ... ).  They do more than name the release.  They have to compile the release.  They have to post it.  They have to write up or prepare release notes.  They might have to announce it.  They might have to make platform-specific fixes.  They might have to investigate platform-specific issues/bugs/requests.  They help keep that platform supported.

Alexon November 18 2013 21:59 UTCappreciated

OK thanks

Alexon November 18 2013 23:07 UTCformat?

Can this be done on a word document or notepad? is there a specific software i should use for creating this? should i convert to pdf ?

Harmanpreet on November 19 2013 02:25 UTCYour Choice

We only need a well written article no matter which editor or word processor is used. Article should be easily readable.


Feel free and choose your favourite editor and start writing.


Best of luck!


 

Sean on November 19 2013 02:51 UTCadd article to wiki

Alex, in addition to what Harmanpreet said, the task description says what to do with the article.  You'll add it to our wiki when it's complete.  You can write the article in anything though.


 

Alexon November 19 2013 16:55 UTCHow to become a maintainer

The paragraph on this page also states i should tell them how to take up the responsibility of becoming a maintainer. how can they do this? so i can write about it.

Alexon November 19 2013 17:57 UTCinclude my name?

also should i include my name in the finished document?

Sean on November 20 2013 06:15 UTCmailing list

Direct them to our brlcad-devel mailing list and/or IRC channel so they can announce their interest and so we can discuss.


And yes, please include your name in the article so we can credit you with your contribution in our official documentation.

Alexon November 20 2013 17:46 UTCUploading to BRL-CAD wiki?

As i am supposed to upload the article to the BRL-CAD wiki, where do i go once on this link: http://brlcad.org/wiki/Community_Publication_Portal


Once im on the link am i supposed to edit the Community Publication Portal and add my new article on the need for a windows software maintainer?

Alexon November 20 2013 19:23 UTCReady for review

The work on this task is ready to be reviewed.

Sean on November 21 2013 05:36 UTCtighten

Alex, this is looking good, but can you tighten it up a little bit.  You repeat your points a little bit in the first two paragraphs, so it should be possible to reduce them without losing any useful information  The subtitle in the middle of your text seems unhelpful as well.  The bulleted list dominates, too, so the article comes across as being an article that explains maintainership more than soliciting the reader.


Think about what the main point you're trying to make is.  Make sure that point gets the emphasis.  

Sean on November 21 2013 05:36 UTCTask 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.

Sean on November 21 2013 05:36 UTCDeadline extended

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

Alexon November 21 2013 15:40 UTCWill improve

Ok thanks for the feedback i will make sure i improve on what you said

Alexon November 21 2013 17:52 UTCReady for review

The work on this task is ready to be reviewed.

Sean on November 22 2013 02:41 UTCTask Closed

Congratulations, this task has been completed successfully.

Sean on November 22 2013 02:51 UTCfantastic

Fantastic work Alex!  If you join our brlcad-news mailing list, you'll eventually see your article when it gets posted.  Thank you for your efforts!