Difference between revisions of "Free Software Directory:Participate"

From Free Software Directory
Jump to: navigation, search
(Added Troubleshooting)
(Mention how to edit multiple pages.)
 
(117 intermediate revisions by 15 users not shown)
Line 1: Line 1:
__NOEDITSECTION__
+
The Free Software Directory is edited by a community of volunteers and FSF staff members.
__NOTOC__
 
<div style="content: '.';visibility: hidden;display: block;height: 0;clear: both;"></div>
 
  
==User account==
+
==Main volunteer categories==
If you don't already have a [https://directory.fsf.org/wiki?title=Special:UserLogin&returnto=Main+Page&type=signup|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.
 
  
== Approval System ==
+
===Software entries===
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.''
+
====Custom entries====
 +
Software entries that are not imported from Debian's meta-data, are added manually to the directory as [[Free Software Directory:Custom entries|custom entries]]
  
* Latest version message: ''This is the approved revision of this page, as well as being the most recent.''
+
* Often Check for [[{{ns:4}}:Buggy entries|buggy entries]] and fix them.
  
You can see a [[Special:ApprovedRevs|list of approved pages or pages waiting for approval]].
+
====Meta-data import====
 +
You must either know or be willing to learn Haskell, or Python, since the source files are written in these programming languages.
  
== How to fill the fields in an entry ==
+
See the [[Free Software Directory:Import|Import]] page.
  
Each entry for a package in the Directory has information structured in  
+
===Administration===
quite a number of fields, some of which are obvious, some less so.
+
Our old backlog is a list with too many entries. So we need to solve the issues in the [[Free_Software_Directory:Issues|Free Software Directory Tracker (FSDT)]] so we can merge the backlog to it. If you want to help, you must either know or be willing to learn Semantic MediaWiki (see [https://www.semantic-mediawiki.org/wiki/Help:User_manual User Manual], since the source files are written in that programming language.
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 ==
+
Administration work on this wiki is made the [[Free Software Directory:Backlog Admin Group|Backlog Admin Group]] that is making decisions together with the Free Software Foundation.
  
These tools are auxiliary, they do not replace this guide or the requirements.
+
For pages that need to be maintained, see [[Special:SpecialPages#Maintenance reports]].
  
* Check out the [[Free Software Directory:Participate/Script aid | script aid]] made by [[User:Adfeno|Adfeno]].
+
====Administration of [[{{ns:4}}:Participate/MediaWiki|MediaWiki]]====
* [[Free Software Directory:Participate/Using pywikibot | Using pywikibot]] to work with entries in the directory.
+
* '''If you are an administrator looking for directions or scripts''', check out the [[{{ns:4}}:Workflow|workflow page]].
 +
* [[{{ns:4}}:Website guidelines|Website guidelines]] for people who want to make contributions to the layout and the design of the directory.
 +
* [[{{ns:-1}}:Version]] is useful for MediaWiki, and Semantic Forms, and so on, when you need to evaluate version specific syntax.
 +
* Finally, if you have experience and a particular interest that you want to work on, you can start or join a team:
  
== Submit new entries ==
+
{{/teams}}
  
To submit a new entry to the directory:
+
==Client system requirements==
+
See also: [[Free Software Directory:Stack|Stack]]
# [http://directory.fsf.org/wiki?title=Special:UserLogin&returnto=Main_Page Login to the directory].
 
# Head to our [[Form:Entry|entry page]].
 
# 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.
 
# 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!'''
+
To edit our wiki, you must have an FSF account. If you don't already have a [{{fullurl:{{ns:-1}}:CreateAccount}} Free Software Foundation Central Login] ([https://my.fsf.org/join member] or [https://my.fsf.org/user/register non-member]), create one, and then click <code>Log In</code> on the Directory.
The reason it is not appearing is because it has been marked
 
as "unapproved". After our team has reviewed your submission thoroughly,
 
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.
 
  
== Update an entry ==
+
===A web browser with JavaScript enabled===
 +
* The Free Software Foundation Central Login requires JavaScript.
 +
* The MediaWiki stack requires JavaScript. We use more than MediaWiki, including Semantic MediaWiki, as well as some other extensions such as the Semantic Forms (see [[Special:Version]] for more information). We once tried doing the form without JavaScript, but to do this we will have to change how the form is built, as well as other templates, and entire namespaces (many pages) that are shown, queried or transcluded by it. It can be done, but it is no trivial/simple task.
  
To update an entry:  
+
=== Edit the FSD with text editors/browsers ===
 +
See our [[Collection:Text mode browsers, and IceCat WebExtensions for text editors]].
  
# [http://directory.fsf.org/wiki?title=Special:UserLogin&returnto=Main_Page Login to the directory].
+
== Editing multiple pages ==
# 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,  
+
See [[/Editing multiple pages|the subpage of the same name]] for hints on how to do that, as well as a script to automate part of the process.
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]]
+
==Forums==
 +
Besides this wiki itself, there are two main channels to follow as part of your participation:
  
== Deleting an entry ==
+
===Mailing-list===
 +
[http://lists.gnu.org/mailman/listinfo/directory-discuss directory-discuss mailing list]
  
If a submission doesn't meet criteria for inclusion in the directory,
+
===Friday IRC Meeting===
it can be proposed for deletion, and deleted by an administrator from the drop-down menu.
+
For details and time of the meeting, check the [[Main_Page|home page]].
To propose an entry for deletion, edit it's description to start with:
 
  
<nowiki>[[Category:Candidates for deletion]]</nowiki>
+
The [https://www.fsf.org/ Free Software Foundation (FSF)] hosts the Friday IRC Meeting to help new volunteers get started working on the Directory, as well as to discuss ongoing or new Directory projects. See the [[Main Page]] for more details about the next meeting.
This is a candidate for deletion: (describe why here) <nowiki>~~~~</nowiki>
 
  
Then it will show up in [[:Category:Candidates for deletion]].
+
== Mentions ==
 +
When you mention a user's profile or name, you must always sign. If you forget the signature (which must always be in the form <code><nowiki>
 +
--~~~~</nowiki></code>) make a minor change to add it.
  
Check on [https://archive.org archive.org] if a package's homepage is gone.
+
In other words, please '''always''' make an internal link to the userpage of the person you are replying to with <code><nowiki>[[User:accountname]]</nowiki></code> ''and'' sign with <code><nowiki>--~~~~</nowiki></code>.<sup>[https://www.mediawiki.org/wiki/Help:Notifications/Types#Mentions ref]</sup> Unsigned mentions will not produce a notification for the mentioned.
  
When an entry is deleted, also search for references to it by other
+
This is specially useful because, if you are commenting in a thread inside a talk page and if you follow this advice, you '''don't''' need to comment on the talk userpage of the person you are replying to.
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.
 
  
If the package is a particularly popular or well-known proprietary
+
<center><hr style="width:50%;">Administration</hr></center>
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
+
== Outreach ==
for its rejection, so users trying to submit a project can know how to
 
correct any errors (if possible)
 
  
== Guidelines for choosing Version Status of an entry ==
+
* Tools for getting [[{{ns:4}}:Participate/maintainers | maintainers]] involved.
  
* Stable: If it has a release and no indication of the type, choose stable.
+
== Dispute resolution ==
* Historical means no longer works on any currently supported free software distribution. Since that is hard to determine, some hints are:
+
* [https://en.wikipedia.org/wiki/Wikipedia:Dispute_resolution Generic dispute resolution]<!-- "If there's like a policy document from wikipedia that we can reference on the topic [of unresolved disputes] that would be helpful." - Donald Robertson -->
** The last release or source code change is probably older than 2007.
+
* [[Free_Software_Directory:Administrative_dispute_resolution|Administrative dispute resolution]]
** 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.
 
 
 
== Troubleshooting ==
 
* [[Special:Version]] - Useful for MediaWiki, and Semantic Forms, and so on, when you need to evaluate version specific syntax.
 
 
 
== Help us maintain and improve the Directory ==
 
 
 
Want to join others in the community and help curate and build the Free
 
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].
 

Latest revision as of 10:04, 19 March 2023

The Free Software Directory is edited by a community of volunteers and FSF staff members.

Main volunteer categories

Software entries

Custom entries

Software entries that are not imported from Debian's meta-data, are added manually to the directory as custom entries

Meta-data import

You must either know or be willing to learn Haskell, or Python, since the source files are written in these programming languages.

See the Import page.

Administration

Our old backlog is a list with too many entries. So we need to solve the issues in the Free Software Directory Tracker (FSDT) so we can merge the backlog to it. If you want to help, you must either know or be willing to learn Semantic MediaWiki (see User Manual, since the source files are written in that programming language.

Administration work on this wiki is made the Backlog Admin Group that is making decisions together with the Free Software Foundation.

For pages that need to be maintained, see Special:SpecialPages#Maintenance reports.

Administration of MediaWiki

  • If you are an administrator looking for directions or scripts, check out the workflow page.
  • Website guidelines for people who want to make contributions to the layout and the design of the directory.
  • Special:Version is useful for MediaWiki, and Semantic Forms, and so on, when you need to evaluate version specific syntax.
  • Finally, if you have experience and a particular interest that you want to work on, you can start or join a team:

Project Teams

Client system requirements

See also: Stack

To edit our wiki, you must have an FSF account. If you don't already have a Free Software Foundation Central Login (member or non-member), create one, and then click Log In on the Directory.

A web browser with JavaScript enabled

  • The Free Software Foundation Central Login requires JavaScript.
  • The MediaWiki stack requires JavaScript. We use more than MediaWiki, including Semantic MediaWiki, as well as some other extensions such as the Semantic Forms (see Special:Version for more information). We once tried doing the form without JavaScript, but to do this we will have to change how the form is built, as well as other templates, and entire namespaces (many pages) that are shown, queried or transcluded by it. It can be done, but it is no trivial/simple task.

Edit the FSD with text editors/browsers

See our Collection:Text mode browsers, and IceCat WebExtensions for text editors.

Editing multiple pages

See the subpage of the same name for hints on how to do that, as well as a script to automate part of the process.

Forums

Besides this wiki itself, there are two main channels to follow as part of your participation:

Mailing-list

directory-discuss mailing list

Friday IRC Meeting

For details and time of the meeting, check the home page.

The Free Software Foundation (FSF) hosts the Friday IRC Meeting to help new volunteers get started working on the Directory, as well as to discuss ongoing or new Directory projects. See the Main Page for more details about the next meeting.

Mentions

When you mention a user's profile or name, you must always sign. If you forget the signature (which must always be in the form --~~~~) make a minor change to add it.

In other words, please always make an internal link to the userpage of the person you are replying to with [[User:accountname]] and sign with --~~~~.ref Unsigned mentions will not produce a notification for the mentioned.

This is specially useful because, if you are commenting in a thread inside a talk page and if you follow this advice, you don't need to comment on the talk userpage of the person you are replying to.


Administration

Outreach

Dispute resolution



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.