Free Software Foundation!

Join now

Difference between revisions of "Free Software Directory:Workflow"

From Free Software Directory
Jump to: navigation,
(added gnu review stuff)
m (Viewing submissions (requests))
(48 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Site Administration ==
+
== License concerns ==
  
Here are some of the pages that an admin will find useful:
+
'''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.
 +
 
 +
=== 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.
 +
 
 +
== 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: [[FSD:Workflow/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":
 +
 
 +
* [[:Category:Bug_report]]
 +
 
 +
When completed, the category gets changed to "Bug report-done"
 +
 
 +
* [[:Category: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":
 +
 
 +
* [[:Form:Submit]]
 +
 
 +
Submissions are in the 'Review' category
 +
 
 +
* [[:Category:Review]]
 +
 
 +
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'.
 +
 
 +
* [[:Category: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 ===
  
 
* [[:Category:Review]]: Submissions for (usually) new packages
 
* [[:Category:Review]]: Submissions for (usually) new packages
 
* [[:Category:Reviewed]]: Submissions that have been processed
 
* [[:Category:Reviewed]]: Submissions that have been processed
* [[:Category:Bug_report]]: Package update submissions
+
* [[:Category:Bug report]]: User submitted bugs and suggestions
* [[:Category:Bug_report-done]]: Submissions that have been processed
+
* [[:Category:Bug_report-done]]: Processed bug reports
 +
 
 +
=== Not mentioned above ===
 +
 
 
* [[:Category:Alert]]: Packages that have been marked as containing non-free software or using non-free documentation
 
* [[:Category:Alert]]: Packages that have been marked as containing non-free software or using non-free documentation
 +
* [[:Category:Alert-done]]: Packages marked as non-free that have been processed
 
* [[:Category:GNU_review]]: Submissions marked as GNU
 
* [[:Category:GNU_review]]: Submissions marked as GNU
 
* [[:Category:GNU_review-done]]: GNU submissions that have been processed
 
* [[:Category:GNU_review-done]]: GNU submissions that have been processed
 +
* [[:Category:Review_license]]: Packages whose license details require double-checking by an experienced administrator
 +
* [[:Category:Documentation]]: All documentation pages
 +
* [[:Category:Test]]: Test pages
  
 
+
=== Site development ===
* [[Form:Entry]]: For creating new official pages that aren't in the directory yet
+
 
+
When editing 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, displaying and allowing you to edit current values.
+
 
+
At the top of pages in the Review: namespace is a link that will allow you to create or edit pages without typing URLs. Currently, making changes on official entries involves manually typing in what you have found, or copying and pasting basic info from user-submissions. To avoid copyright infringement, and to allow us to release the directory under the [http://www.gnu.org/copyleft/fdl.html FDL], please use your own wording for program descriptions.
+
 
+
== 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 brining new features to the directory:
Line 25: Line 81:
 
* [[FSD:Bugs]]: Triaged bugs
 
* [[FSD:Bugs]]: Triaged bugs
 
* [[FSD:Features]]: Potential site improvements
 
* [[FSD:Features]]: Potential site improvements
* [[:Category:Documentation]]: All documentation pages
 
* [[:Category:Bug report]]: User submitted bugs and suggestions
 
* [[:Category:Test]]: Test pages
 
  
 +
=== 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 16:10, 18 January 2013

Contents

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 brining 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.


Personal tools

Variants
Actions
Navigation
Contribute