Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 365189 - Devmanual: Document the process to add news items (glep 42)
Summary: Devmanual: Document the process to add news items (glep 42)
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Quality Assurance Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-04-28 12:44 UTC by Mike Pagano
Modified: 2011-09-17 08:07 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Patch to document the procedures to add a news item (glep 42) (devmanual_news_item.patch,2.98 KB, patch)
2011-04-28 12:44 UTC, Mike Pagano
Details | Diff
news items patch with suggested updates (devmanual_news_item.patch,2.98 KB, patch)
2011-04-28 15:03 UTC, Mike Pagano
Details | Diff
Revised patch with overlay copy and paste error removed (devmanual_news_item.patch,2.97 KB, patch)
2011-04-28 15:22 UTC, Mike Pagano
Details | Diff
Updated patch with suggestions from Markos (hwoarang) (devmanual-gentoo-news.patch,3.48 KB, patch)
2011-09-16 01:03 UTC, Mike Pagano
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Mike Pagano gentoo-dev 2011-04-28 12:44:46 UTC
Created attachment 271445 [details, diff]
Patch to document the procedures to add a news item (glep 42)

The only reference I could find on adding news items came from Fauli's blog post: http://www.faulhammer.org/archiv-mainmenu-31/35-gentoo/282-writing-a-news-item

I mostly stole what he wrote and tried to hack up a devmanual change to add this. I'm hoping he does not mind, I did email him.
Comment 1 Ulrich Müller gentoo-dev 2011-04-28 13:50:12 UTC
Some minor points:

> News Items can be read using the eselect command. More information on use of
> this tool to read or delete news items can be found on the eselect man page.

news.eselect has its own man page, which might be more helpful than the general eselect one.

> (all letters

In fact, lowercase letters only.

> and numbers allowed, plus dash and underscore)

The word "plus" looks like a conjuction here. Maybe write "plus sign" instead?

(You'll find the allowed characters in the pre-commit hook of the gentoo-news repository: a-z, 0-9, + (plus), - (hyphen) and _ (underscore)).
Comment 2 Mike Pagano gentoo-dev 2011-04-28 15:03:10 UTC
Created attachment 271457 [details, diff]
news items patch with suggested updates

Thanks, Ulrich, for the helpful comments. Here is the revised patch.
Comment 3 Tomáš Chvátal (RETIRED) gentoo-dev 2011-04-28 15:06:56 UTC
+<guide self="general-concepts/overlay/">

This looks like copy&pasto
Comment 4 Mike Pagano gentoo-dev 2011-04-28 15:22:01 UTC
Created attachment 271459 [details, diff]
Revised patch with overlay copy and paste error removed

Thanks, that was a copy & paste error
Comment 5 Mike Pagano gentoo-dev 2011-05-06 12:08:39 UTC
Any reason not to commit? Any further changes required?
Comment 6 Mike Pagano gentoo-dev 2011-09-16 01:03:11 UTC
Created attachment 286611 [details, diff]
Updated patch with suggestions from Markos (hwoarang)
Comment 7 Markos Chandras (RETIRED) gentoo-dev 2011-09-17 08:07:35 UTC
I applied it to devmanual. But next time you may want to create a patch in git-format and get all the credits in the commit message :)