Topic on Project:Current issues

Jump to: navigation, search

Installation guide consolidation

7
Nemo bis (talkcontribs)

Manual:Installation guide has one section with a 400 words summary, but then links to a "Main installation guide" composed of 4+4 more pages. None of these pages is translatable. Can we consolidate truly important information and make it translatable? Currently one is supposed to find the following logical steps.

  1. Download
  2. Requirements
  3. The actual installation
  4. Misc troubleshooting and alternatives if something went wrong
  5. Configuration
  6. Maintenance
  7. Informative material

The pages in bold are part of the official Template:InstallationNav (which complements Template:MediaWiki Introduction): they are supposed to be the official path and need special care and coordination.

Nemo bis (talkcontribs)

Given Chad's comment, I'm also going to tag all "platform-specific" manual pages for merge to the main ones. Common parts can be merged and transcluded on the specific pages, while really platform-specific additional information can be left there. P.s.: for a start, I removed 5 guides on obsoleted systems and marked the others for merge.

Nemo bis (talkcontribs)

I made Manual:LocalSettings.php translatable and expanded Manual:System administration by merging Manual:Configuration.

  • Manual:System administration could be useful if it becomes a reasonable index/step by step guide/tutoring of the really important pages in Category:MediaWiki for site admins (allowing to remove respective information from the general installation manual), but I'm not sure of its current role.
  • Manual:LocalSettings.php is very visited, but it's quite a mess. I doubt it kept anywhere close up to date, is it currently making a good service to users?
Ciencia Al Poder (talkcontribs)

I wonder what's the purpose of making Manual:LocalSettings.php translatable if you doubt about the usefulness of that page or if you plan/propose to improve/restructure it.

Nemo bis (talkcontribs)

The page is vastly correct and the strings contained in it look rather stable, so it's ok to translate it. It is my impression that some consolidation will be needed for that page (reducing total amount of text around), but not a rewriting.

Nemo bis (talkcontribs)

I've tried to make the essential stuff transcludable, and I've trimmed some more pages.

IMHO the direction is rather clear:

  • always defer to other sites for guides on how to set up PHP etc.;
  • keep all the steps internal to MediaWiki (like installer, config script, LocalSettings.php) in their own, shared manual pages;
  • in all the setup-specific pages, just transclude the former and maintain only:
    • information on packages available and how to use them (debatable, should be on their sites whenever possibles),
    • OS-specific instructions which can't be found anywhere else, like specific paths to put in MediaWiki config or RAM/suhosin requirements and the like.