Help:Maintenance: Difference between revisions

Jump to navigation Jump to search
m
3rd contrib - cleanup and beginning on categories
(2nd contrib (emergency saving))
m (3rd contrib - cleanup and beginning on categories)
Line 10: Line 10:
But cheer up: despite the above, this wiki gets every day better and better. Ask a maintainer if you don't believe it!
But cheer up: despite the above, this wiki gets every day better and better. Ask a maintainer if you don't believe it!


This document was originally written by someone like you, who thought it could save you some time to get to full speed (like the time you'd use to write your detailed, well thought and argumented plan - too late?).
This document was originally written by someone like you, who thought it could save you some time to get to full speed (like the time you'd use to write your detailed, well thought and argumented plan - too late?).<ref>The source for most of the "historical" notes in this wiki article was [[User talk:Bigstones/Essay:A plan for a reorganization of the wiki]].</ref>


== Working your way up ==
== Working your way up ==
To become a full grown maintainer it is fundamental to get acquainted with [[how the FlightGear project works]]. It's probably less obvious to do than it seems, it'll take time and time spent [[Forum communication|living the community]].
To become a full grown maintainer it is fundamental to get acquainted with how the FlightGear project works. It's probably less obvious to do than it seems, it'll take time and time spent living the community. Some articles you may want to review are:
* [[Volunteer]]
* [[How the FlightGear project works]]
* [[Forum communication]]
* [[Howto:Understand the FlightGear development process]]
* [[Howto:Start core development]]


While reading those documents, it's a good idea getting in the mood of checking if anything can be changed, fixed, made clearer. This is a good exercise. Doing some random maintenance while exploring the wiki will help in gaining confidence with both the project and how the wiki is organized. Mistakes are around the corners, but maintainers will keep an (hopeful) eye on you, so don't be too shy, and if in doubt better to ask than forget.
While reading those documents, it's a good idea getting in the mood of checking if anything can be changed, fixed, made clearer. Doing some random maintenance while exploring the wiki will help in gaining confidence with both the project and how the wiki is organized. Mistakes are around the corners, but maintainers will keep an (hopeful) eye on you, so ''don't be too shy'' and, if in doubt, better to ask than to forget.


=== The summary ===
=== The summary ===
But please, always remember to add a meaningful comment to your edit. It is the "Summary" textfield you can see below the editor textbox. Your common sense should be enough to make up an appropriate description of what you're doing, but if you need examples the [[Special:RecentChanges]] page is a copious source of them.
But please, always remember to add a meaningful comment to your edit. It is the "Summary" textfield you can see below the editor textbox. Your common sense should be enough to make up an appropriate description of what you're doing, but if you need examples the [[Special:RecentChanges]] page is a copious source of them.


This message is important not just as a reference for the future - actually, most of them won't be read anymore - as much as a message to let other maintainers know what you're doing ''now''.
This message is not just a reference for the future - actually, most of them won't be read anymore - as much as a message to let other maintainers know what you're doing ''now''.


=== Recent Changes and Watchlist ===
=== Recent Changes and Watchlist ===
[[Special:RecentChanges]] is the primary maintenance tool of the FlightGear wiki. It is messy at first sight and will require a couple hours of work to get used to it, so it's better to start early. There you can see what's going on, who has been working lately and what was done.
[[Special:RecentChanges]] is the primary maintenance tool of the FlightGear wiki. It is messy at first sight and will require a couple hours of work to get used to it, so it's better to start early. There you can see what's going on, who has been working lately and what was done.


It's a lot of condensed data, and at first you might want to concentrate only on few articles that you're following. You can do that by putting it into your [[Special:Watchlist]], by clicking the star at the top right, next to the search textfield. Not only any edit on such articles will appear in that list, but it will appear in '''bold''' in RecentChanges.
It's a lot of condensed data, and at first you might want to concentrate only on few articles that you're following. You can do that by putting them into your [[Special:Watchlist]], by clicking the star at the top right of their pages, next to the search textfield. Not only any edit on such articles will appear in that list, but it will appear in '''bold''' in RecentChanges.


However, it's unlikely that you're following a very busy article. Those tend to be quite messy and usually regard development stuff that, we'll see later, have their own rules. So you might just "star" your own talk page, to be sure not to lose any message directed to you. Oh, and the [[FlightGear wiki:Village pump|Village pump]]!
However, it's unlikely that you're following a very busy article. Those tend to be quite messy and usually regard development stuff that, we'll see later, have their own rules. So you might just "star" your own talk page, to be sure not to lose any message directed to you. Oh, and the [[FlightGear wiki:Village pump|Village pump]]!


More on tracking changes at [[mw:Help:Tracking changes]]. (In case you're curious, that was an ''interwiki'' link, i.e. a link to another wiki project. When you see something you'd like to know better, you can safely "edit" the article to see the source, closing the page or going back will prevent any actual editing.)
More on tracking changes at [[mw:Help:Tracking changes]].<ref>In case you're curious, that was an ''interwiki'' link, i.e. a link to another wiki project. When you see something you'd like to know better, you can safely "edit" the article to see the source, closing the page or going back will prevent any actual editing.</ref>


=== Category Tree ===
=== Category Tree ===
Another valuable tool, that you might already know if you were a good contributor, is [[Special:CategoryTree]]. It will allow you to have an overview of the categories and their organization. This is possibly the most discussed aspect of the wiki, so once you see it, you might feel the urge of just changing everything as if that was your home directory in your computer.
Another valuable tool, that you might already know if you were a good contributor, is [[Special:CategoryTree]]. It provides you with an overview of the categories and their organization. This is possibly the most discussed aspect of the wiki, so you might feel the urge of just changing everything as if that was your <tt>/home</tt> dir. Chill down, you can't do that: a) [[#Editing categories is cumbersome|it's technically almost impossible]]; b) it needs to be discussed with the more experienced maintainers.


Chill down, you can't do that: a) [[#Limitations of MediaWiki|it's technically almost impossible]]; b) it needs to be discussed with the more experienced maintainers.
However, you can still take a look. You'll see that the FlightGear wiki has a root category, called, with no much surprise, [[:Category:FlightGear wiki]]. You can tell that by looking at [[Special:UncategorizedCategories]], which lists categories that have no parent. So use the CategoryTree tool on that (you may ignore the namespace option, more on [[#Use of namespaces|namespaces]] later) and take some time to see how it's structured.


However, you can still take a look. You'll see that the FlightGear wiki has a root category, called, with no much surprise, [[:Category:FlightGear wiki]]. You can tell that by looking at [[Special:UncategorizedCategories]], which lists categories that have no parent. So use the CategoryTree tool on that (you may ignore the namespace option, more on [[#Use of namespaces|namespaces]] later) and take some time to see how it's structured. Again, try to repulse the need of moving stuff.
In general there should be an Articles category, where all the text content is available, and Files, where the binaries are (probably just images). The other are technical categories, for which the use should be self-explanatory.
 
The current structure is described in detail below, but in general there should be an Articles category, where all the text content is available, and Files, where the binaries are (probably just images). The other are technical categories, for which the use should be self-explanatory.


=== Communication with other maintainers ===
=== Communication with other maintainers ===
Line 48: Line 51:


== Ordinary maintenance tasks ==
== Ordinary maintenance tasks ==
With only few hours of the above, you should be up and running. Here's briefly explained what you can already do. Note that you're ''by no means'' asked to do all the following. Any help will be appreciated.
With only few hours of the above, you should be up and running. Here's briefly explained what you can already do. Note that you're ''by no means'' asked to do all the following, any help will be appreciated.


=== Checking new articles and edits ===
=== Checking new articles and edits ===
Checking [[Special:RecentChanges|Recent Changes]] you might find an entry marked with an '''N''', meaning that a new article has been created. Go and see if it fits the wiki (e.g. doesn't talk about the user's dog), if the title could be made clearer, or formatting could be improved... in brief, check its quality. There are no guidelines about it
Checking [[Special:RecentChanges|Recent Changes]] you might find an entry marked with an '''N''', meaning that a new article has been created. Go and see if it fits the wiki (e.g. doesn't talk about the user's dog), if the title could be made clearer, or formatting could be improved... in brief, check its [[Help:Style guide|quality]].


Moreover, check if it is [[Help:Categories|categorized]] in the most specific category available, especially if it is ''not'' categorized at all! This one, though, might be a task that needs a bit more expertise, particularly for development related articles.
Moreover, check if it is [[Help:Categories|categorized]] in the most specific category available, especially if it is ''not'' categorized at all! This one, though, might be a task that needs a bit more of expertise, particularly for development related articles.


If the new article was made by a new contributor, you might want to leave some hints on his/her talk page to avoid the repeating of any mistake (like forgetting the summary). Needless to say, remember to be nice: that contributor probably did the best he/she could. In fact, you might also consider just thanking them for their addition.
If the new article was made by a new contributor, you might want to leave some hints on his/her talk page to avoid the repetition of any mistake (like forgetting the summary). Needless to say, remember to be nice: that contributor probably did the best he/she could. In fact, you might also consider just thanking them for their addition.


If you change anything, ''remember to leave a proper summary''.
If you change anything, ''remember to leave a proper summary''.
Line 64: Line 67:
You might have heard of the [[wikipedia:Pareto principle|Pareto principle]]. Briefly, it says that 80% of the results are due to 20% of the causes. Applied to the wiki, it could sound like "20% of the wiki pages affect 80% of the wiki quality perception" (''numbers may vary'').
You might have heard of the [[wikipedia:Pareto principle|Pareto principle]]. Briefly, it says that 80% of the results are due to 20% of the causes. Applied to the wiki, it could sound like "20% of the wiki pages affect 80% of the wiki quality perception" (''numbers may vary'').


It's not hard to see that those higher importance articles are of course the most visited ones, that is, of course the [[:Category:Portals]] and all the pages linked there. Try to use them as a user, see if some topics are missing or if it is out of date. If the topic is suitable for you, try to fix that even by searching and asking on the forum about latest updates. Do you see why maintaining documentation is the best way to get into a project?
These pages are of course the most visited ones, that is, the [[:Category:Portals]] and all the pages linked there. Try to use them as a user, see if some topics are missing or if it is out of date. If the topic is suitable for you, try to fix that even by searching and asking on the forum about latest updates.


Other than the portals, another page that needs to stay up to date is [[Frequently asked questions]]. Try to remove, or at least [[Help:Templates#Different types of templates|signal with a template]], questions that you presume asked no more that frequently. Also, by following the forum you should be able to know what really are the FAQs, so consider adding them if missing. In the answers, try to point to existing articles instead of duplicating information (see [[#Some guiding principles|below]]).
Another page that needs to stay up to date is [[Frequently asked questions]]. Try to remove, or at least [[Help:Templates#Different types of templates|signal with a template]], questions that you presume asked no more that frequently. Also, by following the forum you should be able to know what really are the FAQs, so consider adding them if missing. In the answers, try to point to existing articles instead of duplicating information (see [[#Some guiding principles|below]]).


Then, if you're out of "most visited pages", just check [[Special:PopularPages]], which has (at the time of writing) about 1,900 of them.
Then, if you're out of "most visited pages", just check [[Special:PopularPages]], which has (at the time of writing) about 1,900 of them.
Line 91: Line 94:


== Current organization of the categories ==
== Current organization of the categories ==
{{stub}}
[[:Category:FlightGear wiki|FlightGear wiki]] is the root category. From there, you can easily browse all the categories. Note that existing category pages have a short description at the top, which might need to be maintained as well as other pages, but is intended to be a guide for working with them.
this should be a guide for categorizing articles, and possibly explain particular uses of the particular ones.
 
Although in WikiMedia the category hierarchy might seem to be shaped like an actual tree (and could be so), more often it is structured like a web. In fact, every article


=== Use of namespaces ===
=== Use of namespaces ===
{{stub}}


== Limitations of MediaWiki ==
== Limitations of MediaWiki ==
=== Categorizing like tagging doesn't work ===
=== Categorizing like tagging doesn't work ===
MediaWiki doesn't support (at least natively) the use of categories like tags, that is, the use of two or more unrelated categories that combine to make a particular one. This happens because ''when browsing'' the categories you can't combine them. So one should always use the most particular category that is possible.
MediaWiki doesn't support (at least natively) the use of categories like tags, that is, the use of two or more unrelated categories that combine to make a particular one. This happens because ''when browsing'' the categories you can't combine them. So one should always use the most particular category that is possible, which might not be easy, given the convoluted nature of the category tree that even presents some huge loops.


An example: if an article is about creating airport layouts, it shouldn't be "tagged" with Scenery and Development (they're both into [[:Category:FlightGear]]), but classified into Scenery enhancement (which is another way of saying "scenery development").
An example: if an article is about creating airport layouts, it shouldn't be "tagged" with Scenery and Development (they're both into [[:Category:FlightGear]]), but classified into Scenery enhancement (which is another way of saying "scenery development").
Line 111: Line 116:


== References ==
== References ==
The source for most of the "historical" notes in this wiki article was [[User talk:Bigstones/Essay:A plan for a reorganization of the wiki]].
<references/>
<references/>


[[Category:Help]]
[[Category:Help]]
573

edits

Navigation menu