Difference between revisions of "Free Software Directory:Participate"

From Free Software Directory
Jump to: navigation, search
m (→‎Editing the FSD with text editors/browsers)
(Mention how to edit multiple pages.)
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<div style="content: '.';visibility: hidden;display: block;height: 0;clear: both;"></div>
 
−
 
 
The Free Software Directory is edited by a community of volunteers and FSF staff members.
 
The Free Software Directory is edited by a community of volunteers and FSF staff members.
  
−
Besides this wiki itself, there are two main channels to follow as part of your participation:
+
==Main volunteer categories==
  
−
* The '''[http://lists.gnu.org/mailman/listinfo/directory-discuss directory-discuss mailing list]'''.
+
===Software entries===
−
* The '''Friday Free Software Directory IRC meeting'''. For details and time of the meeting, check the [[Main_Page|home page]].
 
  
−
Anybody can update or submit new entries to the Directory, including their own programs. Please review the [[{{ns:4}}:Requirements|requirements]] for entries.<br>
+
====Custom entries====
−
The [[#Project Teams|project teams]] are subscribed to the mailing list and often attend the meetings, assisting and guiding the users when necessary.
+
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]]
  
−
To submit a new entry or update an existing one, 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.
+
* Often Check for [[{{ns:4}}:Buggy entries|buggy entries]] and fix them.
  
−
== Submit new 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.
  
−
To submit a new entry to the directory:
+
See the [[Free Software Directory:Import|Import]] page.
−
 
−
# [[{{ns:-1}}:UserLogin|Login to the directory]].
 
−
# Head to our '''[[{{ns:106}}:Entry|'Submit a new entry' page]]'''. (Also linked in the sidebar.)
 
−
# Enter the name of the package or software program.
 
−
# You will be brought to a multi-part form -- don't panic!<br>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.  
 
  
−
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.
+
===Administration===
−
* Not the latest version message: <q>This is the approved revision of this page; it is not the most recent. View the most recent revision.</q>
+
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.
−
* Latest version message: <q>This is the approved revision of this page, as well as being the most recent.</q>
 
  
−
Until approved you can review or improve your submission by editing it as outlined below.
+
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.
  
−
== Update an entry ==
+
For pages that need to be maintained, see [[Special:SpecialPages#Maintenance reports]].
  
−
To update an entry:  
+
====Administration of [[{{ns:4}}:Participate/MediaWiki|MediaWiki]]====
−
# [[{{ns:-1}}:UserLogin|Login to the directory]].
+
* '''If you are an administrator looking for directions or scripts''', check out the [[{{ns:4}}:Workflow|workflow page]].
−
# Click "Edit with Form" at the top-right of the page you'd like to update.
+
* [[{{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:
  
−
When you update an entry, you edit the latest version of the page, approved or not.
+
{{/teams}}
  
−
To find entries that haven't been updated in a while, check the [[{{ns:4}}:Golden Oldies|Golden Oldies]] project team's page. You can also see a [[{{ns:-1}}: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!
+
==Client system requirements==
 +
See also: [[Free Software Directory:Stack|Stack]]
  
−
=== Searching in source trees ===
+
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.
  
−
When it is necessary to verify that the source code of a software contains or does not contain certain terms it is good to use automated GNU tools.
+
===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.
  
−
Recursive search is a technique that starts from a custom root directory and examines the contents of all descendant nodes (files and directories) in the filesystem. Recursive search allows you to search for text in an entire source tree with a single command, without the need to use graphical interfaces.
+
=== Edit the FSD with text editors/browsers ===
 +
See our [[Collection:Text mode browsers, and IceCat WebExtensions for text editors]].
  
−
A basic <i>example</i> of this kind of deep search using regular expressions is:
+
== Editing multiple pages ==
  
−
grep --recursive --ignore-case --files-with-matches --extended-regexp "^.*(commercial|proprietary|license|rights).*$" ./src/
+
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.
  
−
This <i>example</i> is a good starting point: it does a case-insensitive search in <i>all</i> files contained in the directory <code>./src</code> of the words matched by the regular expression (commercial, proprietary, license and rights, <code>^</code> matches the beginning of a line, <code>$</code> matches the end of a line). You can add the option <code>--invert-match</code> to match the words that are <i>not</i> matched by the regular expression and remove the option <code>--files-with-matches</code> to also view the matched contents and not only the file names. This tool accesses the files in read-only mode and does not cause alterations, so it is possible to practice at will by gradually making changes to the command line.
+
==Forums==
−
 
+
Besides this wiki itself, there are two main channels to follow as part of your participation:
−
Execute <code>info grep</code> for more information.
 
−
 
 
−
Lastly, there are scripts and packages which might be useful for the review, even for newcommers. As for packages, examples include the simpler <code>licensecheck</code> and the more advanced <code>fossology</code>. For the case of scripts, the community keeps a list of [[{{ns:4}}:Scripts|scripts]] which might be helpful.
 
−
 
 
−
== 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 [https://packages.debian.org/stretch/allpackages package in stretch]).
 
−
** 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 [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.
 
−
 
 
−
== 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:
 
−
 
 
−
<blockquote>
 
−
: <nowiki>[[Category:Candidates for deletion]]</nowiki>
 
−
:: This is a candidate for deletion: (describe why here) <nowiki>--~~~~</nowiki>
 
−
</blockquote>
 
−
 
 
−
Then it will show up in [[:{{ns:14}}:Candidates for deletion|the category about candidates for deletion]].
 
  
−
Please always state "Other/additional reason:" when you delete entries, because when a page is deleted, it will show up in [[{{ns:-1}}: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 [[Talk:IceCat/Web_of_Trust_-_WOT]]).
+
===Mailing-list===
 +
[http://lists.gnu.org/mailman/listinfo/directory-discuss directory-discuss mailing list]
  
−
If the issue is that the software is no longer available, make sure to check on [https://archive.org archive.org]. Archive.org can sometimes be the last home for free software that is no longer maintained but could still be useful.
+
===Friday IRC Meeting===
 +
For details and time of the meeting, check the [[Main_Page|home page]].
  
−
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 [[{{ns:-1}}:WhatLinksHere|What links here]] tool comes handy when hunting down the links.
+
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.
−
 
 
−
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.
 
−
 
 
−
== Editing the FSD with text editors/browsers ==
 
−
Our [[Free_Software_Directory:Website_guidelines#Avoid_JavaScript.2C_directly_or_indirectly|website guidelines comply with non-JS text editing]].
 
−
 
 
−
; Text browsers
 
−
* [[Lynx]]
 
−
* [[w3m]] (which can also be used by Emacs via the emacs-w3m.el Emacs Lisp module)
 
−
* [[Emacs Web Wowser]] (EWW)
 
−
 
 
−
; [[IceCat]] WebExtensions
 
−
* [[GhostText]]: Supported text editors: [[Atom]], [[Emacs]], [[Vim]], [[Neovim]]
 
−
* [[Org Capture]]: Supported text editor: Emacs
 
−
* [[withExEditor]]: Supported text editor: Any
 
  
 
== Mentions ==
 
== 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>
 
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.
 
--~~~~</nowiki></code>) make a minor change to add it.
Line 112: Line 64:
  
 
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.
 
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.
−
 
  
 
<center><hr style="width:50%;">Administration</hr></center>
 
<center><hr style="width:50%;">Administration</hr></center>
−
 
−
== Administration of [[{{ns:4}}:Participate/MediaWiki|MediaWiki]] ==
 
−
 
−
* '''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.
 
−
* Check often for [[{{ns:4}}:Buggy entries|buggy entries]] and fix them.
 
−
* [[{{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:
 
−
 
−
{{/teams}}
 
  
 
== Outreach ==
 
== Outreach ==

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.

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