Free Software Foundation!

Join now

Difference between revisions of "Free Software Directory:Workflow"

From Free Software Directory
Jump to: navigation,
m (Adding/rejecting new entries: rewording)
(rearranged the info more logically, so license info is all together and at the top)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
 +
== License concerns ==
 +
 +
'''Please note:''' When publishing a new entry to the Free Software Directory, please make sure that it meets our [[FSD:Requirements|requirements]], and that another administrator who is experienced in publishing new entries to the directory reviews your work. If the license is not a free software license, then it should not be added to the directory. Therefore, '''check the license first!'''
 +
 +
* If you conclude that we can't admit a entry into the Directory, then change the status of the relevant submission to "reviewed" and add your (nice) comments explaining why above the template. See [[Review:0_A.D.-REV-ID-1]] for an example.
 +
 +
=== When updating an existing entry ===
 +
 +
* When updating license info for a package, please make sure it meets the FSF's [[FSD:Requirements|requirements]], and ask another FSD administrator to review your work. (Either click the right checkbox on a bug report's "Edit with form" tab, or file a bug report with "Problem with this listing?" at the bottom of the project's page). Also, if you update the license info or confirm that it is correct in a newer version, be sure to update the ''License reviewed by'' and ''License reviewed date'' fields for that package.
 +
* When updating an existing package in the Directory, if you suspect the package has changed and become proprietary software, then this should be flagged for urgent review immediately. Also, contact another administrator letting them know about the situation.
 +
* If you are having trouble updating or checking the license for a package, don't let this halt updating other aspects of the package's information. Simply update the information you can and then either update the existing bug report, or create a new bug report that states the license info needs to be checked and updated. Note that this applies to ''updating'' a license, not ''adding'' a new project to the directory.
  
 
== Bugs and suggestions ==
 
== Bugs and suggestions ==
Line 11: Line 23:
  
 
If you edit a bug report using "edit with form", you can mark the it as having been reviewed. This changes the category automatically.
 
If you edit a bug report using "edit with form", you can mark the it as having been reviewed. This changes the category automatically.
 
=== Updating existing entries ===
 
 
To update an existing entry, click an individual bug link, then click the "edit the page" link.
 
 
Some important things to do when updating a submission:
 
 
* In the ''Documentation note'' and ''Version comment'' fields, make sure all URLs are formatted as external links. Simply pasting the URL is bad because it does not create a clickable link and because long URLs create formatting errors due to poor line wrap support.
 
* Make sure IRC channels are formatted as URIs in the formatted like such: ''irc://irc.gnu.org/channelname'' — notice that the hash tag of the channelname is optional.
 
* The ''Submitted by'' and ''Submitted date'' should only be edited the first time a project is submitted. 
 
* If you are making a very minor change, do not bother updating the ''Last reviewed'' fields. However, if you are updating the software to indicate a new version has been released or have improved it in other substantial and interesting ways, make sure you updated the ''Last reviewed by'' and ''Last reviewed date''. This will add it to an RSS feed of recent updates.
 
* Notes about licenses:
 
** When updating license info for a package, please make sure it meets the FSF's [[FSD:Requirements|requirements]], and ask another FSD administrator to review your work. (Either click the right checkbox on a bug report's "Edit with form" tab, or file a bug report with "Problem with this listing?" at the bottom of the project's page). Also, if you update the license info or confirm that it is correct in a newer version, be sure to update the ''License reviewed by'' and ''License reviewed date'' fields for that package.
 
** When updating an existing package in the Directory, if you suspect the package has changed and become proprietary software, then this should be flagged for urgent review immediately. Also, contact another administrator letting them know about the situation.
 
** If you are having trouble updating or checking the license for a package, don't let this halt updating other aspects of the package's information. Simply update the information you can and then either update the existing bug report, or create a new bug report that states the license info needs to be checked and updated. Note that this applies to ''updating'' a license, not ''adding'' a new project to the directory.
 
  
 
== Viewing submissions (requests) ==
 
== Viewing submissions (requests) ==
Line 41: Line 38:
  
 
If you edit the "Finished review=No" field to say "Yes," then this will happen automatically.
 
If you edit the "Finished review=No" field to say "Yes," then this will happen automatically.
 
=== Adding/rejecting new entries ===
 
 
'''Please note:''' When publishing a new entry to the Free Software Directory, please make sure that it meets our [[FSD:Requirements|requirements]], and that another administrator who is experienced in publishing new entries to the directory reviews your work. If the license is not a free software license, then it should not be added to the directory. Therefore, '''check the license first!'''
 
 
* If you conclude that we can't admit a entry into the Directory, then change the status of the submission to "reviewed" and add your (nice) comments explaining why above the template. See [[Review:0_A.D.-REV-ID-1]] for an example.
 
  
 
== About editing with forms ==
 
== About editing with forms ==
Line 55: Line 46:
  
 
When you want to edit a page, you have the option of using "Edit" or "Edit with Form". The first allows you to see the source code of the page and offers more flexibility, whereas the second one presents you with a convenient form layout, allowing you to edit current values.
 
When you want to edit a page, you have the option of using "Edit" or "Edit with Form". The first allows you to see the source code of the page and offers more flexibility, whereas the second one presents you with a convenient form layout, allowing you to edit current values.
 +
 +
=== Entry editing tips and guidelines ===
 +
 +
* In the ''Documentation note'' and ''Version comment'' fields, make sure all URLs are formatted as external links. Simply pasting the URL is bad because it does not create a clickable link and because long URLs create formatting errors due to poor line wrap support.
 +
* Make sure IRC channels are formatted as URIs in the formatted like such: ''irc://irc.gnu.org/channelname'' — notice that the hash tag of the channelname is optional.
 +
* The ''Submitted by'' and ''Submitted date'' should only be edited the first time a project is submitted. 
 +
* If you are making a very minor change, do not bother updating the ''Last reviewed'' fields. However, if you are updating the software to indicate a new version has been released or have improved it in other substantial and interesting ways, make sure you updated the ''Last reviewed by'' and ''Last reviewed date''. This will add it to an RSS feed of recent updates.
  
 
== Organization of FSD ==
 
== Organization of FSD ==

Revision as of 16:59, 16 August 2012


License concerns

Please note: When publishing a new entry to the Free Software Directory, please make sure that it meets our requirements, and that another administrator who is experienced in publishing new entries to the directory reviews your work. If the license is not a free software license, then it should not be added to the directory. Therefore, check the license first!

  • If you conclude that we can't admit a entry into the Directory, then change the status of the relevant submission to "reviewed" and add your (nice) comments explaining why above the template. See Review:0_A.D.-REV-ID-1 for an example.

When updating an existing entry

  • When updating license info for a package, please make sure it meets the FSF's requirements, and ask another FSD administrator to review your work. (Either click the right checkbox on a bug report's "Edit with form" tab, or file a bug report with "Problem with this listing?" at the bottom of the project's page). Also, if you update the license info or confirm that it is correct in a newer version, be sure to update the License reviewed by and License reviewed date fields for that package.
  • When updating an existing package in the Directory, if you suspect the package has changed and become proprietary software, then this should be flagged for urgent review immediately. Also, contact another administrator letting them know about the situation.
  • If you are having trouble updating or checking the license for a package, don't let this halt updating other aspects of the package's information. Simply update the information you can and then either update the existing bug report, or create a new bug report that states the license info needs to be checked and updated. Note that this applies to updating a license, not adding a new project to the directory.

Bugs and suggestions

Requested updates to existing submissions get categorized as "Bug report":

When completed, the category gets changed to "Bug report-done"

If you edit a bug report using "edit with form", you can mark the it as having been reviewed. This changes the category automatically.

Viewing submissions (requests)

New entry requests are created with "Form:Submit":

Submissions are categorized as Review:

When review is complete the category is changed to Reviewed.

If you edit the "Finished review=No" field to say "Yes," then this will happen automatically.

About editing with forms

  • Form:Submit: Anyone with a user account can submit a package for review
  • Form:Entry: Admins can use this to create new project pages

At the top of pages in the Review: namespace is a link that will allow you to create or edit entries without typing URLs or entering a name into Form:Entry. Currently, to make changes to an entry's content you must type in your own sentences, and copy and paste basic info. To avoid copyright infringement, please use your own wording for program descriptions.

When you want to edit a page, you have the option of using "Edit" or "Edit with Form". The first allows you to see the source code of the page and offers more flexibility, whereas the second one presents you with a convenient form layout, allowing you to edit current values.

Entry editing tips and guidelines

  • In the Documentation note and Version comment fields, make sure all URLs are formatted as external links. Simply pasting the URL is bad because it does not create a clickable link and because long URLs create formatting errors due to poor line wrap support.
  • Make sure IRC channels are formatted as URIs in the formatted like such: irc://irc.gnu.org/channelname — notice that the hash tag of the channelname is optional.
  • The Submitted by and Submitted date should only be edited the first time a project is submitted.
  • If you are making a very minor change, do not bother updating the Last reviewed fields. However, if you are updating the software to indicate a new version has been released or have improved it in other substantial and interesting ways, make sure you updated the Last reviewed by and Last reviewed date. This will add it to an RSS feed of recent updates.

Organization of FSD

Here are some pages that an admin will find useful:

Categories mentioned above

Not mentioned above

Site development

These links are useful for people working on fixing and brining new features to the directory:




Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.


Personal tools

Variants
Actions
Navigation
Contribute