Difference between revisions of "Free Software Directory:Backlog Admin Group"

From Free Software Directory
Jump to: navigation, search
(David Hedlund approved to add myself in the BAG)
(Mention FSD:Website guidelines as a guideline for layouts and designs.)
(45 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<onlyinclude>The '''Backlog Admin Group''' ('''BAG''') is a group dedicated to work on client-side technical issues of our [[Free_Software_Directory:Backlog|Backlog]].</onlyinclude>
+
The '''Backlog Admin Group''' ('''BAG''') is a dedicated group to work on our [[Free_Software_Directory:Backlog|Backlog]].
  
{| class="wikitable sortable" border="1"
+
'''Team Captain:''' [[User:David_Hedlund|David Hedlund]].
|-
 
! colspan="3" | Group info
 
! colspan="4" | User info
 
|-
 
! Administrator
 
! Role
 
! Reference
 
! Real name
 
! [[Template:Participate text|libera.chat nick]]
 
! Time zone
 
! Title
 
|-
 
! [[User:Adfeno|Adfeno]]
 
| Member
 
|
 
| Adonay Felipe Nogueira
 
| adfeno
 
| America/Sao_Paulo
 
|
 
|-
 
! [[User:Andi89gi|Andi89gi]]
 
| Member
 
|
 
| Andreas Artz
 
| andi89gi
 
| Europe/Wettenberg
 
|
 
|-
 
! [[User:David Hedlund|David_Hedlund]]
 
| Team captain
 
|
 
| David Hedlund
 
| David_Hedlund
 
| Europe/Stockholm
 
|
 
|-
 
! [[User:Mmcmahon|Mmcmahon]]
 
| Server administrator (see [[#Server upgrade logs|logs]])
 
|
 
| Michael McMahon
 
| thomzane
 
| America/New_York
 
| [https://www.fsf.org/about/staff-and-board#michael FSF Web Developer]
 
|-
 
! [[User:Saper|Saper]]
 
| Member
 
|
 
| Marcin Cieślak
 
| saper
 
| Europe/Warsaw
 
|
 
|-
 
! [[User:Noisytoot|Noisytoot]]
 
| Member
 
|
 
| Ron Nazarov
 
| Noisytoot
 
| Europe/London
 
|
 
|-
 
! [[User:Panos_Alevropoulos|Panos Alevropoulos]]
 
| Member
 
|
 
| Panos Alevropoulos
 
| panosalevro
 
| Europe/Athens
 
| Lawyer
 
|}
 
  
For internal meetings, the column about <code>Time zone</code> from the above table can be used to display what would be the members' local time when the meeting start, given  this example: <code>TZ="MEMBER_TIME_ZONE" date --date='TZ="America/New_York" 12:00 this Fri'</code>.
+
{{#ask:[[Member of team::{{FULLPAGENAME}}]]
 +
  |?TZ database time zone name
 +
  |?IRC Freenode nick
 +
  |offset=0
 +
  |limit=500
 +
}}
  
==Server upgrade logs==
+
For internal meetings, the column about [[Property:TZ database time zone name]] from the above link can be used to display what would be the members' local time when the meeting start, given  this example: <code>TZ="MEMBER_TIME_ZONE" date --date='TZ="America/New_York" 12:00 this Fri'</code>.
{| class="wikitable sortable" border="1"
 
|-
 
! MediaWiki
 
! Date
 
! Extensions
 
! Date
 
! Modules
 
! Date
 
|-
 
| [Version]
 
| [Date]
 
| Only foo, and bar
 
| [Date]
 
| All modules (except...)
 
| [Date]
 
|-
 
| [Version]
 
| [Date]
 
| All extension
 
| [Date]
 
| All modules
 
| [Date]
 
|}
 
 
 
Example policy:
 
* 2023 and later: upgrade MediaWiki, all MediaWiki modules, and all MediaWiki extensions, the final quarter each year. This could be automated with a script.
 
 
 
== Pages ==
 
{{Special:PrefixIndex/Free Software Directory:Backlog Admin Group/|stripprefix=yes}}
 
 
 
== We need more members ==
 
People at [irc://chat.freenode.net/#mediawiki Freenode#mediawiki] and [irc://chat.freenode.net/#semantic-mediawiki Freenode#semantic-mediawiki] should be skilled in MediaWiki. We could gently ask if someone in those IRC channels wants to candidate to be a member of our team so we can solve more complex tasks in our [[Free_Software_Directory:Backlog_active|Backlog]] faster.
 
:Example of a generic participation request:
 
::Hi <i>$firstName</i>,<br><br>I am an <i>$senderRole</i> of the Free Software Directory (FSD: <https://$currentDirectoryDomain/>), an ever-growing and user-editable web catalog of free software. We are searching for free software enthusiasts who are willing to dedicate their time and skills into volunteering for our project, with the ultimate aim of promoting free software and assisting end users. Your help is needed to translate or create the pages and/or, if you have computer science expertise, in verifying the existing pages and improving the functionalities of the FSD's infrastructure.<br>We await for your contributions during the weekly IRC meetings of the Free Software Foundation, don't miss out! (guide: <https://$currentDirectoryDomain/wiki/Free_Software_Directory:Participate>)<br><br>Best regards,<br><i>%senderName</i>
 
  
 
== Membership policy ==
 
== Membership policy ==
  
 
* The Backlog Admin Group only accept volunteers with [[Special:ListUsers/sysop|Administrator]] privileges.
 
* The Backlog Admin Group only accept volunteers with [[Special:ListUsers/sysop|Administrator]] privileges.
 
==Routine work==
 
* Check entries that not yet have been marked with "Runs on: GNU/Linux" (example: https://directory.fsf.org/wiki?title=Python&diff=86049&oldid=86048)
 
* Merge ideas and tasks from the directory-discuss mailing to the Directory. Lots of people have good ideas how to improve the Directory but often don't remember to add something about it in the Directory (or don't even think about it), or don't know where they should add it in the Directory.
 
  
 
== Schedule ==
 
== Schedule ==
Line 135: Line 34:
 
I think we should keep these permissions for two reasons 1) the FSF will get gratis sysadmin work 2) the members in BAG will learn to work with the backend. For the moment only saper is a skilled MW admin but other group members would like learn how to maintain MW.
 
I think we should keep these permissions for two reasons 1) the FSF will get gratis sysadmin work 2) the members in BAG will learn to work with the backend. For the moment only saper is a skilled MW admin but other group members would like learn how to maintain MW.
  
===Why it's needed===
+
== Candidates for membership ==
The Backlog Admin Group once had access to that server for the purpose of
 
testing and implementing changes on pages with a high transclusion
 
(read: reuse) count (this includes templates). This was done so that a
 
potential breaking change on the development server would not negatively
 
impact the main instance. For the surface of the complexity, go to ([https://directory.fsf.org/wiki/Special:ReplaceText Special:ReplaceText])
 
again, but look for the sections afterward which talk about form editing.
 
  
Back when I had more time to participate on the meetings, I saw that it
+
* People at irc://chat.freenode.net/#mediawiki and irc://chat.freenode.net/#semantic-mediawiki at <code>chat.freenode.net</code> if full of people that are skilled with ParserFunctions, we should gently ask if someone want to be part of our team. -- [[User:Adfeno|Felipe]] ([[User_talk:Adfeno|talk]])
was very helpful to have that instance running, specially since many of
 
the BAG members were not familiar with administration of Semantic
 
MediaWiki and MediaWiki in general. On top of that, the fact that both
 
of these are actually websites full of server-side processing along with
 
some client-side JavaScript, for more than 15,000 pages, makes
 
preventing stalls/overloads very difficult, the same can be said to
 
setup a local testing instance for those not skilled on setting up a server.
 
  
Back then, many contributors were comfortable using tools such as a text
+
: Hi [[User:Adfeno|Felipe]], participating to the FSD requires strict adherence to the ideals of both the FSF and the GNU Project and the availability to dedicate at least 4h a week to the FSD meetings. I don't think anyone would object if you (''with common consensus'') recruit a single additional member, as long as - for security reasons - he sustains an apprenticeship period before getting the administrative privileges. ''Festina lente.'' --[[User:LorenzoAncora|LorenzoAncora]] ([[User talk:LorenzoAncora|talk]]) 08:46, 5 May 2020 (EDT)
editor, a web browser (for testing stuff using dummy/sandbox wiki pages
 
on the FSD), and others had average skill on using other tools.
 
  
Before we had the development instance, an attempt was made to use
+
:: I see what you mean, [[User:LorenzoAncora|LorenzoAncora]]. That said, I agree with you, this was an idea given initially when only I and [[User:David_Hedlund|David_Hedlund]] were the only ones maitaining FSD. That said, if all from [[FSD:Backlog Admin Group]] agree, we can close/delete this subsection since I also agree that it's not applicable. --[[User:Adfeno|Adfeno]] ([[User talk:Adfeno|talk]]) 15:48, 5 May 2020 (EDT)
[[Special:ReplaceText]] ([https://directory.fsf.org/wiki/Special:ReplaceText Special:ReplaceText]) to make the FSD follow the SPDX, so to
 
allow the SPDX Group (that is, the FSD project team of that name), to
 
work on the FSD, but that attempt caused a massive MediaWiki job queue
 
([https://directory.fsf.org/wiki?title=Free_Software_Directory:Backlog_active&oldid=88496#Replace_License_text_in_program_entries ref]).
 
 
 
=== Alternative ===
 
 
 
See [[#Editing multiple pages]].
 
  
 
== Testing pages in the main instance ==
 
== Testing pages in the main instance ==
Line 174: Line 50:
 
First read the [[FSD:Hack|hacking section]]. After this pick an aspect to modify.
 
First read the [[FSD:Hack|hacking section]]. After this pick an aspect to modify.
  
If you don't know the property name that you want to work on, go to [[Form:Entry]] (or the <code>Submit a new entry</code> link in the navigation menu), then click on '''Edit'''. This is the form that appears for editing both new and existing entries, and to do so it uses many templates, all of which are responsible for actually setting the properties for each entry (look for lines with <code>{{{for template</code>). When done, [[Form:Entry]] automatically makes or updates a page which uses {{Tl|Entry}}, that is to be discussed later in this section.
+
For properties, one could do like this:
  
Following along with the templates used by [[Form:Entry]], as an example, {{Tl|Project license}} sets [[Property:License]], and the form itself restricts it so that each usage [https://directory.fsf.org/wiki/Special:AllPages?from=&to=&namespace=502 must refer to an existing page in the License namespace]. In summary this is an example of a restriction/constraint defined inside the form.
+
* Property:<custom name>
 +
* [[Form:Entry]] (click on Edit)
 +
* [[Property:Has resource kind]]
 +
* [[Property:License]]
 +
* [[Property:Resource kind]]
 +
* [[Template:Entry]]
 +
* [[Template:Print entry]]
 +
* [[Template:Print software category]]
 +
* [[Template:Show]]
  
When a page is being viewed by a visitor/guest, {{Tl|Entry}} calls {{Tl|Show}}, which in turn makes use of a series of other templates, all responsible for printing not only the properties set by {{Tl|Entry}} but by many other templates. On {{Tl|Show}}, look for <code>#ask:</code> and <code>#show:</code> Semantic MediaWiki queries.
+
To manage possible properties for an entry and its templates, go to any entry and "Edit" it (without the form), in the bottom you will see a list of all templates it currently uses. All templates go like this:
  
Now that you know the property name, in order to edit it as well as its type and other constraints, look at <code>Property:<Property name></code>. For example, [[Property:License]], is of type {{#show: Property:License |?Has type }}. This is an example of a restriction/constraint set inside the property's page (visit [[Property:License]] and click '''Edit''').
+
* {{Tl|Entry}} is the property-setter, and is the one used by [[Form:Entry]], so {{Tl|Entry}} doesn't display anything to the pages by itself.
 +
* {{Tl|Print entry}} is a intermediary --- it prints somethings but only if called.
 +
* {{Tl|Show}} calls {{Tl|Print entry}} and other intermediary templates in order to display things.
 +
* The first thing that {{Tl|Entry}} does is to call {{Tl|Show}}, then it proceeds to do all the property settings.
  
Some times, form constraints conflict with ones on the property's page, so templates might need to make intermediary changes.
+
[[Form:Entry]] or (the <code>Submit a new entry</code> link in the navigation menu) is used to display editable things that can be found in "Edit with form". When done, [[Form:Entry]] automatically makes a page which uses {{Tl|Entry}}.
 
 
== Editing multiple pages ==
 
 
 
See [[FSD:Participate/Editing multiple pages]].
 
  
 
== How to add file upload to form edit ==
 
== How to add file upload to form edit ==
Line 205: Line 88:
 
* Use (Main) as name space.
 
* Use (Main) as name space.
 
* Set "NAMESPACE:<title>" in the title wpNewTitleMain text form, example: "Draft:Main page"
 
* Set "NAMESPACE:<title>" in the title wpNewTitleMain text form, example: "Draft:Main page"
 +
 +
== Issues ==
 +
 +
=== Assigned ===
 +
 +
* [[FSD:Backlog active#Show changes (TOP_PRIORITY)]]: [[User:Adfeno|Adfeno]]
 +
 +
=== Not assigned ===
 +
 +
==== Set empty default values ====
 +
 +
This is a Semantic MediaWiki issue.
 +
 +
I find that most of my problems concerning empty or missing properties in a template are helped by setting default template values. You might need to poke runJobs.php. Then you can query on the default value. So you might have Template:Software looking like:
 +
 +
Software license: [[SoftwareLicense::{{{LICENSE|None}}}]]
 +
 +
Then you can pick out the pages with undeclared software license by ask'ing on [[SoftwareLicense::None]] to get the ones that aren't declared.
 +
 +
==== Homepage shouldn't be required ====
 +
 +
* The "Homepage" field should not mandatory to fill in entries. For [[Icedove]] doesn't have any homepage and it shouldn't be set to the Thunderbird homepage because it's not free due to trade mark issues.
 +
* [[FSD:Backlog#Donald]]. <!-- always keep that link here -->
 +
 +
==== Non-official compiled/non-source releases ====
 +
 +
Should we add to [[FSD:Requirements]] that we only permit data related to official releases? For example, the current Windows download link for [[IceCat]] is unofficial, but it's made by jenslody@fedoraproject.org
 +
(20:43:02) David_Hedlund: But it's still a unofficial release. I think we should discuss this policy.
  
 
== External links ==
 
== External links ==
  
 
* [https://www.mediawiki.org/wiki/Help:Magic_words Magic words]
 
* [https://www.mediawiki.org/wiki/Help:Magic_words Magic words]
* [https://www.mediawiki.org/wiki/ResourceLoader/Core_modules MediaWiki's ResourceLoader Core Modules], which exposes many things that can be used for example, on [[MediaWiki:Common.js]] and similar JavaScript files.
 
  
 
[[Category:Project Team]]
 
[[Category:Project Team]]

Revision as of 16:43, 5 May 2020

The Backlog Admin Group (BAG) is a dedicated group to work on our Backlog.

Team Captain: David Hedlund.

 TZ database time zone nameIRC Freenode nick
Marcin CieślakEurope/Warsawsaper
Michael McMahonAmerica/New_Yorkthomzane

For internal meetings, the column about Property:TZ database time zone name from the above link can be used to display what would be the members' local time when the meeting start, given this example: TZ="MEMBER_TIME_ZONE" date --date='TZ="America/New_York" 12:00 this Fri'.

Membership policy

  • The Backlog Admin Group only accept volunteers with Administrator privileges.

Schedule

  • We'll schedule meetings every year or so to actually operate in group activity.

Guidelines

Testing instance

During David's internship: The BAG members got full access to a fresh copy of the main server to investigate setting files etc:

The FSF will consider if we will keep it after David's internship.

I think we should keep these permissions for two reasons 1) the FSF will get gratis sysadmin work 2) the members in BAG will learn to work with the backend. For the moment only saper is a skilled MW admin but other group members would like learn how to maintain MW.

Candidates for membership

Hi Felipe, participating to the FSD requires strict adherence to the ideals of both the FSF and the GNU Project and the availability to dedicate at least 4h a week to the FSD meetings. I don't think anyone would object if you (with common consensus) recruit a single additional member, as long as - for security reasons - he sustains an apprenticeship period before getting the administrative privileges. Festina lente. --LorenzoAncora (talk) 08:46, 5 May 2020 (EDT)
I see what you mean, LorenzoAncora. That said, I agree with you, this was an idea given initially when only I and David_Hedlund were the only ones maitaining FSD. That said, if all from FSD:Backlog Admin Group agree, we can close/delete this subsection since I also agree that it's not applicable. --Adfeno (talk) 15:48, 5 May 2020 (EDT)

Testing pages in the main instance

See the test category.

How to modify Form:Entry

First read the hacking section. After this pick an aspect to modify.

For properties, one could do like this:

To manage possible properties for an entry and its templates, go to any entry and "Edit" it (without the form), in the bottom you will see a list of all templates it currently uses. All templates go like this:

  • {{Entry}} is the property-setter, and is the one used by Form:Entry, so {{Entry}} doesn't display anything to the pages by itself.
  • {{Print entry}} is a intermediary --- it prints somethings but only if called.
  • {{Show}} calls {{Print entry}} and other intermediary templates in order to display things.
  • The first thing that {{Entry}} does is to call {{Show}}, then it proceeds to do all the property settings.

Form:Entry or (the Submit a new entry link in the navigation menu) is used to display editable things that can be found in "Edit with form". When done, Form:Entry automatically makes a page which uses {{Entry}}.

How to add file upload to form edit

To do.

Special pages not found in Special:SpecialPages

Special workarounds

Unlisted name spaces

  • Move the page
  • Use (Main) as name space.
  • Set "NAMESPACE:<title>" in the title wpNewTitleMain text form, example: "Draft:Main page"

Issues

Assigned

Not assigned

Set empty default values

This is a Semantic MediaWiki issue.

I find that most of my problems concerning empty or missing properties in a template are helped by setting default template values. You might need to poke runJobs.php. Then you can query on the default value. So you might have Template:Software looking like:

Software license: None

Then you can pick out the pages with undeclared software license by ask'ing on None to get the ones that aren't declared.

Homepage shouldn't be required

  • The "Homepage" field should not mandatory to fill in entries. For Icedove doesn't have any homepage and it shouldn't be set to the Thunderbird homepage because it's not free due to trade mark issues.
  • FSD:Backlog#Donald.

Non-official compiled/non-source releases

Should we add to FSD:Requirements that we only permit data related to official releases? For example, the current Windows download link for IceCat is unofficial, but it's made by jenslody@fedoraproject.org (20:43:02) David_Hedlund: But it's still a unofficial release. I think we should discuss this policy.

External links



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.