Difference between revisions of "Free Software Directory:Participate"

From Free Software Directory
Jump to: navigation, search
m
(37 intermediate revisions by 8 users not shown)
Line 3: Line 3:
 
<div style="content: '.';visibility: hidden;display: block;height: 0;clear: both;"></div>
 
<div style="content: '.';visibility: hidden;display: block;height: 0;clear: both;"></div>
  
==Create account==
+
Anybody can update or submit new entries to the directory. Please review the [[{{ns:4}}:Requirements|Requirements]].
Click on "Create account" in this wiki to add a ''Free Software Foundation Central Login Username'', either as a [https://my.fsf.org/join member] or [https://my.fsf.org/user/register non-member].
 
  
== Approval System ==
+
To edit, you must register first. If you don't already have a [{{fullurl:Special:CreateAccount}} Free Software Foundation Central Login] ([https://my.fsf.org/join member] or [https://my.fsf.org/user/register non-member]) you need to create one: It is mandatory to allow this wiki software to allow you to edit on it.
Anybody can update or submit new entries to the
 
Directory. Please review the
 
[[Free_Software_Directory:Requirements|Requirements]]. However, updates
 
and new submissions need approval by an administrator before they will
 
appear publicly. Logged-in users can tell if they are seeing the latest
 
version of the page, or if there are newer versions of the page waiting
 
for approval by a message at the top of the page.  
 
  
* Not the latest version message: ''This is the approved revision of this page; it is not the most recent. View the most recent revision.''
+
We talk about three things here -- how to submit, update, and delete entries.  
 
 
* Latest version message: ''This is the approved revision of this page, as well as being the most recent.''
 
 
 
You can see a [[Special:ApprovedRevs|list of approved pages or pages waiting for approval]].
 
 
 
== How to fill the fields in an entry ==
 
 
 
Each entry for a package in the Directory has information structured in
 
quite a number of fields, some of which are obvious, some less so.
 
Please check out the
 
[[Free_Software_Directory:Workflow/Entry|documentation for an entry]],  
 
to assist you with relevant information on the requirements, meaning, or
 
expectations for the content.
 
 
 
== Tools ==
 
 
 
These tools are auxiliary, they do not replace this guide or the requirements.
 
 
 
* Check out the [[Free Software Directory:Participate/Script aid | script aid]] made by [[User:Adfeno|Adfeno]].
 
* [[Free Software Directory:Participate/Using pywikibot | Using pywikibot]] to work with entries in the directory.
 
  
 
== Submit new entries ==
 
== Submit new entries ==
Line 41: Line 13:
 
To submit a new entry to the directory:
 
To submit a new entry to the directory:
 
   
 
   
# [http://directory.fsf.org/wiki?title=Special:UserLogin&returnto=Main_Page Login to the directory].
+
# [[Special:UserLogin|Login to the directory]].
# Head to our [[Form:Entry|entry page]].
+
# Head to our '''[[Form:Entry|'Submit a new entry' page]]'''. (Also linked in the sidebar.)
 
# Enter the name of the package or software program.
 
# Enter the name of the package or software program.
# You will be brought to a multi-part form -- don't panic! Only the first few fields are required.  
+
# You will be brought to a multi-part form -- don't panic! Only the first few fields are required. ([[{{ns:4}}:Workflow/Entry|Form documentation]] helps you to complete the form, but it can also be completed by another volunteer or by the reviewer.)
 
# The final step is to go to the last tab and press the '''save button''' at the bottom.  
 
# The final step is to go to the last tab and press the '''save button''' at the bottom.  
  
Please note that when you save, your submission won't appear. '''Don't Panic!'''
+
Please note that when you save, your submission won't appear. '''Don't Panic!''' The reason it is not appearing is because updates and new submissions need approval by an administrator before they will appear publicly. Logged-in users can tell if they are seeing the latest version of the page, or if there are newer versions of the page waiting for approval by a message at the top of the page.
The reason it is not appearing is because it has been marked
+
* Not the latest version message: ''This is the approved revision of this page; it is not the most recent. View the most recent revision.''
as "unapproved". After our team has reviewed your submission thoroughly,
+
* Latest version message: ''This is the approved revision of this page, as well as being the most recent.''
completed adding as much data as possible, and ensured it meets all of  
+
 
our guidelines, your submission will be published on the Directory.  
+
Until approved you can review or improve your submission by editing it as outlined below.
Until approved you can review or improve your submission by editing it  
 
as outlined below.
 
  
 
== Update an entry ==
 
== Update an entry ==
  
 
To update an entry:  
 
To update an entry:  
 +
# [[Special:UserLogin|Login to the directory]].
 +
# Click "Edit" at the top-right of the page you'd like to update.
 +
 +
When you update an entry, you edit the latest version of the page, approved or not.
  
# [http://directory.fsf.org/wiki?title=Special:UserLogin&returnto=Main_Page Login to the directory].
+
To find entries that haven't been updated in a while, check the [[{{ns:4}}:Participate/oldies]] page and [[{{ns:4}}:Broken links]]. You can also see a [[Special:ApprovedRevs|list of approved pages or pages waiting for approval]]. They are often added by people who are new and do not complete the form fully. Please correct and expand these entries to help the reviewers and reduce the review queues!
# Click "Edit With Form" at the top of the page you'd like to update.
 
  
When you update an entry, you edit the latest version of the page,
+
== Guidelines for choosing Version Status of an entry ==
approved or not.
 
  
To find entries that haven't been updated in a while, check the [[Free Software Directory:Participate/oldies]] page and [[Free Software Directory:Broken links]]
+
* Stable: If it has a release and no indication of the type, choose stable.
 +
* Historical means no longer works on any currently supported free software distribution. Since that is hard to determine, some hints are:
 +
** The last release or source code change is probably older than 2007.
 +
** It's not being maintained by Debian (it's not a [https://packages.debian.org/wheezy/allpackages package in wheezy]).
 +
** If you are using a GNU/Linux distro, it doesn't compile or run for you.
 +
You can always revive historical free software to run again.
  
== Deleting an entry ==
+
==Friday IRC Meeting==
 +
The Free Software Foundation (FSF) that hosts the Friday IRC Meeting might or might not edit the Free Software Directory during the meetings depending on what they need to do on their working time.
  
If a submission doesn't meet criteria for inclusion in the directory,
+
== Delete an entry ==
it can be proposed for deletion, and deleted by an administrator from the drop-down menu.
 
To propose an entry for deletion, edit it's description to start with:
 
  
<nowiki>[[Category:Candidates for deletion]]</nowiki>
+
If a submission doesn't meet criteria for inclusion in the directory, it can be proposed for deletion, and deleted by an administrator from the drop-down menu. To propose an entry for deletion, edit it's description to start with:
This is a candidate for deletion: (describe why here) <nowiki>~~~~</nowiki>
+
: <nowiki>[[Category:Candidates for deletion]]</nowiki>
 +
:: This is a candidate for deletion: (describe why here) <nowiki>~~~~</nowiki>
  
 
Then it will show up in [[:Category:Candidates for deletion]].
 
Then it will show up in [[:Category:Candidates for deletion]].
 +
 +
Please always state "Other/additional reason:" when you delete entries, because when a page is deleted, it will show up in [[Special:Log/delete|the deletion log]] with a stated reason for its rejection, so users trying to submit a project can know how to correct any errors (if possible). Preserve Talk pages when appropriate (eg for malware like [[Blacklist/Web of Trust - WOT]]).
  
 
Check on [https://archive.org archive.org] if a package's homepage is gone.
 
Check on [https://archive.org archive.org] if a package's homepage is gone.
  
When an entry is deleted, also search for references to it by other  
+
When an entry is deleted, also search for references to it by other entries. For example, it may be listed as a "related project" for some other entries. These references need to be edited out manually; deleting an entry does not automatically remove them. The [[Special:WhatLinksHere|What links here]] tool comes handy when hunting down the links.
entries. For example, it may be listed as a "related project" for some  
+
 
other entries. These references need to be edited out manually; deleting
+
If the package is a particularly popular or well-known proprietary package, it might make more sense to have the page redirect to free alternatives already listed on the directory. That way, if a person searches the directory for the proprietary program, they can be directed to free equivalents.
an entry does not automatically remove them. The  
+
 
[[Special:WhatLinksHere|What links here]] tool comes handy when hunting  
+
== Donations and Cryptocurrency Donations ==
down the links.
+
 
 +
Entries have a space for listing where users can donate, as well as a checkbox for indicating that the project accepts cryptocurrency donations. The donation text box should be filled with the url to the project's donate page, not the particular cryptocurrency address. This is because the address could change, and it also means that we don't have to verify the wallet address when listing the donations.
 +
 
 +
== Project Teams ==
 +
 
 +
If you have a particular interest that you want to work on, you can start or join a [[{{ns:4}}:Participate/Project Team| Project Team]].
 +
 
 +
== Guidelines ==
 +
 
 +
Here follows the guidelines for actions beyond managing entries in the directory:
 +
 
 +
; [[Free_Software_Directory:Website guidelines|Website guidelines]]
 +
: for people who want to make contributions to the layout and the design of the directory.
 +
 
 +
== Extra ==
  
If the package is a particularly popular or well-known proprietary
+
You can join the '''[http://lists.gnu.org/mailman/listinfo/directory-discuss directory-discuss list]''' or join us each week for the '''Friday Free Software Directory IRC meeting'''! For details and time (and how to figure it out in your time zone), check the [[{{PAGENAME}}|main page]].
package, it might make more sense to have the page redirect to free
 
alternatives already listed on the directory. That way, if a person
 
searches the directory for the proprietary program, they can be directed
 
to free equivalents.  
 
  
When a page is deleted, it will show up in [[Special:Log/delete|the deletion log]] with a stated reason
+
These tools are auxiliary, they do not replace this guide or the requirements.
for its rejection, so users trying to submit a project can know how to
 
correct any errors (if possible)
 
  
 +
* Directory import project: The project enables us to import package information from free software repositories. Long ago a friend put together scripts that we used to import thousands of entries. But thousands upon thousands more could be added if we update the import scripts. The project has been sitting idle for a while now at <[https://savannah.gnu.org/p/directory https://savannah.gnu.org/p/directory]>, just waiting for volunteers to jump in and refine it.
 +
* [[{{ns:4}}:Participate/Approval script|Automating revision approval]] by [[User:Iank|Ian Kelling]].
 +
* Check out the [[{{ns:4}}:Participate/Script aid | script aid]] made by [[User:Adfeno|Adfeno]].
 +
* Check for [[Free Software Directory:Buggy entries|buggy entries]] and fix them.
 +
* Use Pywikibot to work with entries in the directory: [[Free Software Directory:Pywikibot|Pywikibot]], [[{{ns:4}}:Participate/Using pywikibot | Using pywikibot]]
 +
* Set up the [[Free Software Directory:Eggdrop|eggdrop]] IRC bot.
 +
* [[Special:Version]] - Useful for MediaWiki, and Semantic Forms, and so on, when you need to evaluate version specific syntax.
 +
* If you are an administrator looking for directions, check out the [[{{ns:4}}:Workflow|workflow page]].''
 +
* For admins to quickly review and approve many changes, see [[{{ns:4}}:Participate/Approval script | Approval script]].
 +
<!-- Move this to the Free_Software_Directory:Workflow/Entry ?
 
== Guidelines for choosing Version Status of an entry ==
 
== Guidelines for choosing Version Status of an entry ==
 
 
* Stable: If it has a release and no indication of the type, choose stable.
 
* Stable: If it has a release and no indication of the type, choose stable.
 
* Historical means no longer works on any currently supported free software distribution. Since that is hard to determine, some hints are:  
 
* Historical means no longer works on any currently supported free software distribution. Since that is hard to determine, some hints are:  
Line 105: Line 101:
 
** If you are using a Gnu/Linux distro, it doesn't compile or run for you.
 
** If you are using a Gnu/Linux distro, it doesn't compile or run for you.
 
You can always revive historical free software to run again.
 
You can always revive historical free software to run again.
 +
-->
  
== Help us maintain and improve the Directory ==
+
== Outreach ==
  
Want to join others in the community and help curate and build the Free
+
* Tools for getting [[{{ns:4}}:Participate/maintainers | maintainers]] involved.
Software Directory?
 
* Join the [http://lists.gnu.org/mailman/listinfo/directory-discuss directory-discuss list] and send an email asking us how you can help!
 
* If you are an administrator looking for directions, check out the [[FSD:Workflow|workflow page]].
 
* Join us each week for the Friday Free Software Directory IRC meeting! For details and time, check the [http://www.fsf.org/blogs FSF blog].
 

Revision as of 12:01, 19 June 2018


Anybody can update or submit new entries to the directory. Please review the Requirements.

To edit, you must register first. If you don't already have a Free Software Foundation Central Login (member or non-member) you need to create one: It is mandatory to allow this wiki software to allow you to edit on it.

We talk about three things here -- how to submit, update, and delete entries.

Submit new entries

To submit a new entry to the directory:

  1. Login to the directory.
  2. Head to our 'Submit a new entry' page. (Also linked in the sidebar.)
  3. Enter the name of the package or software program.
  4. You will be brought to a multi-part form -- don't panic! Only the first few fields are required. (Form documentation helps you to complete the form, but it can also be completed by another volunteer or by the reviewer.)
  5. The final step is to go to the last tab and press the save button at the bottom.

Please note that when you save, your submission won't appear. Don't Panic! The reason it is not appearing is because updates and new submissions need approval by an administrator before they will appear publicly. Logged-in users can tell if they are seeing the latest version of the page, or if there are newer versions of the page waiting for approval by a message at the top of the page.

  • Not the latest version message: This is the approved revision of this page; it is not the most recent. View the most recent revision.
  • Latest version message: This is the approved revision of this page, as well as being the most recent.

Until approved you can review or improve your submission by editing it as outlined below.

Update an entry

To update an entry:

  1. Login to the directory.
  2. Click "Edit" at the top-right of the page you'd like to update.

When you update an entry, you edit the latest version of the page, approved or not.

To find entries that haven't been updated in a while, check the Free Software Directory:Participate/oldies page and Free Software Directory:Broken links. You can also see a list of approved pages or pages waiting for approval. They are often added by people who are new and do not complete the form fully. Please correct and expand these entries to help the reviewers and reduce the review queues!

Guidelines for choosing Version Status of an entry

  • Stable: If it has a release and no indication of the type, choose stable.
  • Historical means no longer works on any currently supported free software distribution. Since that is hard to determine, some hints are:
    • The last release or source code change is probably older than 2007.
    • It's not being maintained by Debian (it's not a package in wheezy).
    • If you are using a GNU/Linux distro, it doesn't compile or run for you.

You can always revive historical free software to run again.

Friday IRC Meeting

The Free Software Foundation (FSF) that hosts the Friday IRC Meeting might or might not edit the Free Software Directory during the meetings depending on what they need to do on their working time.

Delete an entry

If a submission doesn't meet criteria for inclusion in the directory, it can be proposed for deletion, and deleted by an administrator from the drop-down menu. To propose an entry for deletion, edit it's description to start with:

[[Category:Candidates for deletion]]
This is a candidate for deletion: (describe why here) ~~~~

Then it will show up in Category:Candidates for deletion.

Please always state "Other/additional reason:" when you delete entries, because when a page is deleted, it will show up in the deletion log with a stated reason for its rejection, so users trying to submit a project can know how to correct any errors (if possible). Preserve Talk pages when appropriate (eg for malware like Blacklist/Web of Trust - WOT).

Check on archive.org if a package's homepage is gone.

When an entry is deleted, also search for references to it by other entries. For example, it may be listed as a "related project" for some other entries. These references need to be edited out manually; deleting an entry does not automatically remove them. The What links here tool comes handy when hunting down the links.

If the package is a particularly popular or well-known proprietary package, it might make more sense to have the page redirect to free alternatives already listed on the directory. That way, if a person searches the directory for the proprietary program, they can be directed to free equivalents.

Donations and Cryptocurrency Donations

Entries have a space for listing where users can donate, as well as a checkbox for indicating that the project accepts cryptocurrency donations. The donation text box should be filled with the url to the project's donate page, not the particular cryptocurrency address. This is because the address could change, and it also means that we don't have to verify the wallet address when listing the donations.

Project Teams

If you have a particular interest that you want to work on, you can start or join a Project Team.

Guidelines

Here follows the guidelines for actions beyond managing entries in the directory:

Website guidelines
for people who want to make contributions to the layout and the design of the directory.

Extra

You can join the directory-discuss list or join us each week for the Friday Free Software Directory IRC meeting! For details and time (and how to figure it out in your time zone), check the main page.

These tools are auxiliary, they do not replace this guide or the requirements.

  • Directory import project: The project enables us to import package information from free software repositories. Long ago a friend put together scripts that we used to import thousands of entries. But thousands upon thousands more could be added if we update the import scripts. The project has been sitting idle for a while now at <https://savannah.gnu.org/p/directory>, just waiting for volunteers to jump in and refine it.
  • Automating revision approval by Ian Kelling.
  • Check out the script aid made by Adfeno.
  • Check for buggy entries and fix them.
  • Use Pywikibot to work with entries in the directory: Pywikibot, Using pywikibot
  • Set up the eggdrop IRC bot.
  • Special:Version - Useful for MediaWiki, and Semantic Forms, and so on, when you need to evaluate version specific syntax.
  • If you are an administrator looking for directions, check out the workflow page.
  • For admins to quickly review and approve many changes, see Approval script.

Outreach



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.