[Features] Special Request for Feature Page Cleanup Projecy
All: It has been requested that we add date/timestamps to the Features pages in order to highlight the age of each page and assist users in determining how fresh information is. After investigating various options to do this within the database or using automated code, it seems that the old-fashioned manual way is still the best option. This is because an automated solution would only insert the needed strings, but not the actual data that pertains to that feature. To divide this work among the community, I have made an inventory of all of the features pages in the oVirt.org site as of 3/30/14, located at http://bit.ly/1iA1HQ3. If everyone can take a look at this sheet (check the tabs on the bottom, too) and find the pages they created or for which they are responsible, the following steps should be taken for pages that are marked "Yes" in "Needs Datestamp": 1. Add the following line to the top of each page, under the first heading: {{Feature|name=[Name of Feature]}|modules=[Node(s) of feature]|version=[oVirt version number]|status=Released}} 2. On the Feature page spreadsheet on Google Docs, change the "Yes" in "Needs Datestamp" to "No." This new Feature template string will add the time and date information to the page automatically. If, along the way, you find features that have been deprecated, or feature pages that are duplicates, these pages should be cleaned up as well. Ideally, this should not take too much time for each individual, and the effort will be a big step towards documentation consistency on the oVirt site. If you have any questions/concerns, send them my way. Thanks, BKP -- Brian Proffitt oVirt Community Manager Project Atomic Community Lead Open Source and Standards, Red Hat - http://community.redhat.com Phone: +1 574 383 9BKP IRC: bkp @ OFTC
On Wed, Apr 30, 2014 at 11:18:05AM -0400, Brian Proffitt wrote:
All:
It has been requested that we add date/timestamps to the Features pages in order to highlight the age of each page and assist users in determining how fresh information is. After investigating various options to do this within the database or using automated code, it seems that the old-fashioned manual way is still the best option. This is because an automated solution would only insert the needed strings, but not the actual data that pertains to that feature.
To divide this work among the community, I have made an inventory of all of the features pages in the oVirt.org site as of 3/30/14, located at http://bit.ly/1iA1HQ3.
If everyone can take a look at this sheet (check the tabs on the bottom, too) and find the pages they created or for which they are responsible, the following steps should be taken for pages that are marked "Yes" in "Needs Datestamp":
1. Add the following line to the top of each page, under the first heading:
{{Feature|name=[Name of Feature]}|modules=[Node(s) of feature]|version=[oVirt version number]|status=Released}}
2. On the Feature page spreadsheet on Google Docs, change the "Yes" in "Needs Datestamp" to "No."
This new Feature template string will add the time and date information to the page automatically.
3. drop the old-style "== Current status ==" section, with its "Last updated" line. The one thing worse than no information is conflicting information...
If, along the way, you find features that have been deprecated, or feature pages that are duplicates, these pages should be cleaned up as well. Ideally, this should not take too much time for each individual, and the effort will be a big step towards documentation consistency on the oVirt site.
If you have any questions/concerns, send them my way.
What does "Feature Template" (column D) mean? I do not suppose that that's the exact opposite of "Needs Template".
Some if the Features pages have been created with the Feature template, which means they already have the time/date stamp and do not need to be updated for this project. Peace, Brian ----- Original Message -----
From: "Dan Kenigsberg" <danken@redhat.com> To: "Brian Proffitt" <bproffit@redhat.com> Cc: devel@ovirt.org Sent: Thursday, May 1, 2014 11:09:48 AM Subject: Re: [ovirt-devel] [Features] Special Request for Feature Page Cleanup Projecy
On Wed, Apr 30, 2014 at 11:18:05AM -0400, Brian Proffitt wrote:
All:
It has been requested that we add date/timestamps to the Features pages in order to highlight the age of each page and assist users in determining how fresh information is. After investigating various options to do this within the database or using automated code, it seems that the old-fashioned manual way is still the best option. This is because an automated solution would only insert the needed strings, but not the actual data that pertains to that feature.
To divide this work among the community, I have made an inventory of all of the features pages in the oVirt.org site as of 3/30/14, located at http://bit.ly/1iA1HQ3.
If everyone can take a look at this sheet (check the tabs on the bottom, too) and find the pages they created or for which they are responsible, the following steps should be taken for pages that are marked "Yes" in "Needs Datestamp":
1. Add the following line to the top of each page, under the first heading:
{{Feature|name=[Name of Feature]}|modules=[Node(s) of feature]|version=[oVirt version number]|status=Released}}
2. On the Feature page spreadsheet on Google Docs, change the "Yes" in "Needs Datestamp" to "No."
This new Feature template string will add the time and date information to the page automatically.
3. drop the old-style "== Current status ==" section, with its "Last updated" line. The one thing worse than no information is conflicting information...
If, along the way, you find features that have been deprecated, or feature pages that are duplicates, these pages should be cleaned up as well. Ideally, this should not take too much time for each individual, and the effort will be a big step towards documentation consistency on the oVirt site.
If you have any questions/concerns, send them my way.
What does "Feature Template" (column D) mean? I do not suppose that that's the exact opposite of "Needs Template".
participants (2)
-
Brian Proffitt -
Dan Kenigsberg