Difference between revisions of "Free Software Directory:Workflow"

From Free Software Directory
Jump to: navigation, search
(re-arranged, simplified, etc.)
m (fix typo)
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
__NOTOC__
+
'''NOTE: This page is out of date. Please see a note on our latest [[Free_Software_Directory:Participate|approval system]]. This page remains because we are still in the process of cleaning-up the existing bugs and new submissions described below.'''
  
−
== Bugs and suggestions ==
+
== License concerns ==
−
Requested updates to existing submissions get categorized as "Bug report":
+
 
 +
'''Please note:''' When publishing a new entry to the Free Software Directory, please make sure that it meets our [[FSD:Requirements|requirements]]. 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 have questions about whether a program should be added, you can ask the directory-discuss@gnu.org mailing list.
 +
 
 +
* If you conclude that we can't admit a entry into the Directory, then change the status of relevant submissions to "reviewed" and add your (nice) comments explaining why above the template. See [[Review:0_A.D.-REV-ID-1]] for an example.
  
−
* [[:Category:Bug_report]]
+
=== When updating an existing entry ===
  
−
When completed, the category gets changed to "Bug report-done"
+
* 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.
  
−
* [[:Category:Bug_report-done]]
+
== Types of contribution ==
  
−
If you edit a bug report using "edit with form", you can mark the it as having been reviewed. (The category changes automatically.)
+
* [[Form:Entry]]: Admins can use this to create new project pages. (see below.)
 +
* [[Form:Submit]]: Anyone with a user account can ask for a package to be added to the directory.
 +
* Anyone with a user account can file a bug report, using one of the links on entry pages.
  
−
=== Updating existing entries ===
+
== About editing with forms ==
  
−
To update an existing entry, click an individual bug link, then click the "edit the page" link.  
+
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.
  
−
Some important things to do when updating a submission:
+
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.
  
−
* 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.
+
=== Entry editing tips and guidelines ===
−
* 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.
 
−
* The licensing section deserves its own wiki page, but for now:
 
−
** When updating license info for a package, please ask another FSD administrator to review your work. (You can do that either via a checkbox on the review's "Edit with form" tab, or by clicking "Problem with this listing?" at the bottom of a project's page). Also, if you do update the license info or have confirmed 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 in the ''Review:'' namespace or create a new Bug that states the package license info needs to be checked and updated.
 
  
−
== Viewing submissions (requests) ==
+
There is a manual that describes the meaning of each field in Form:Entry: [[FSD:Workflow/Entry|Guide to Form:Entry]]. It also marks which fields are important or required.
−
New entry requests are created with "Form:Submit":  
 
  
−
* [[:Form:Submit]]
+
== Bugs and suggestions ==
 +
''Requested'' updates to existing submissions get categorized as "Bug report":
  
−
Submissions are categorized as Review:
+
* [[:Category:Bug_report]]
  
−
* [[:Category:Review]]
+
When completed, the category gets changed to "Bug report-done"
  
−
When review is complete the category is changed to Reviewed.
+
* [[:Category:Bug_report-done]]
  
−
* [[:Category:Reviewed]]
+
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 the "Finished review=No" field to say "Yes," then this will happen automatically.
+
== Viewing submissions (requests) ==
 +
New entry creation ''requests'' (submissions) are created with "Form:Submit":
  
−
== Accepting/rejecting submissions ==
+
* [[:Form:Submit]]
  
−
'''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 submissions to the directory reviews your work.
+
Submissions are in the 'Review' category
  
−
* If you conclude that we can't admit a submission into the Directory, then change the status to reviewed and add your comments explaining why (nicely) above the template. See [[Review:0_A.D.-REV-ID-1]] for an example.
+
* [[:Category:Review]]
  
−
== About editing with forms ==
+
After you actually add an entry to the directory through [[Form:Entry]], edit the "Finished review=No" field to say "Yes", to change category to 'Reviewed'.
−
* [[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.
+
* [[:Category:Reviewed]]
  
−
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.
+
If you accept the submission and add it to the Directory, it is nice to email the person who submitted it and let them know it is there now. You might mention the weekly IRC meetings and see if they are interested in helping us maintain this entry and others. You can set the reply-to address as <directory@fsf.org> if you like.
  
 
== Organization of FSD ==
 
== Organization of FSD ==
Line 65: Line 64:
 
* [[:Category:Reviewed]]: Submissions that have been processed
 
* [[:Category:Reviewed]]: Submissions that have been processed
 
* [[:Category:Bug report]]: User submitted bugs and suggestions
 
* [[:Category:Bug report]]: User submitted bugs and suggestions
−
* [[:Category:Bug_report-done]]: Update requests that have been processed
+
* [[:Category:Bug_report-done]]: Processed bug reports
  
 
=== Not mentioned above ===
 
=== Not mentioned above ===
Line 79: Line 78:
 
=== Site development ===
 
=== Site development ===
  
−
These links are useful for people working on fixing and brining new features to the directory:
+
These links are useful for people working on fixing and bringing new features to the directory:
  
 
* [[FSD:Hack]]: Tutorial links
 
* [[FSD:Hack]]: Tutorial links
Line 85: Line 84:
 
* [[FSD:Features]]: Potential site improvements
 
* [[FSD:Features]]: Potential site improvements
  
 +
=== Free Software Distros ===
 +
 +
Some places to coordinate work specific to [http://www.gnu.org/distros/free-distros.html free software distros].
 +
 +
* [[FSD:Trisquel]]: Trisquel packages that should be added to the FSD.
 +
 +
Also, see [[FSD:GNU]].
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Revision as of 07:16, 3 June 2016

NOTE: This page is out of date. Please see a note on our latest approval system. This page remains because we are still in the process of cleaning-up the existing bugs and new submissions described below.

License concerns

Please note: When publishing a new entry to the Free Software Directory, please make sure that it meets our requirements. 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 have questions about whether a program should be added, you can ask the directory-discuss@gnu.org mailing list.

  • If you conclude that we can't admit a entry into the Directory, then change the status of relevant submissions 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.

Types of contribution

  • Form:Entry: Admins can use this to create new project pages. (see below.)
  • Form:Submit: Anyone with a user account can ask for a package to be added to the directory.
  • Anyone with a user account can file a bug report, using one of the links on entry pages.

About editing with forms

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

There is a manual that describes the meaning of each field in Form:Entry: Guide to Form:Entry. It also marks which fields are important or required.

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 creation requests (submissions) are created with "Form:Submit":

Submissions are in the 'Review' category

After you actually add an entry to the directory through Form:Entry, edit the "Finished review=No" field to say "Yes", to change category to 'Reviewed'.

If you accept the submission and add it to the Directory, it is nice to email the person who submitted it and let them know it is there now. You might mention the weekly IRC meetings and see if they are interested in helping us maintain this entry and others. You can set the reply-to address as <directory@fsf.org> if you like.

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 bringing new features to the directory:

Free Software Distros

Some places to coordinate work specific to free software distros.

  • FSD:Trisquel: Trisquel packages that should be added to the FSD.

Also, see FSD:GNU.


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.

Retrieved from "https://directory.fsf.org/wiki?title=Free_Software_Directory:Workflow&oldid=35741"