Difference between revisions of "Contributing"

From the Linux and Unix Users Group at Virginia Teck Wiki
Jump to: navigation, search
(Tags: Mobile edit, Mobile web edit)
(quick summary of how to update)
 
Line 15: Line 15:
 
* Use transclusion for VTLUUG portal
 
* Use transclusion for VTLUUG portal
 
* See [[:Category:Needs restoration]]
 
* See [[:Category:Needs restoration]]
 +
 +
== Updating the wiki ==
 +
This is more for sysadmins than contributors but below are the steps laid out to update this and [https://gobblerpedia.org/wiki/Main_page Gobblerpedia] ([https://www.mediawiki.org/wiki/MediaWiki MediaWiki]). This has been taken from [https://www.mediawiki.org/wiki/Manual:Upgrading the MediaWiki's Upgrade Guide].
 +
 +
# Run pending jobs
 +
#: <pre>php maintenance/runJobs.php</pre>
 +
# Back up the database, settings, and content
 +
#: [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Backing_up_a_wiki Basic Instructions]
 +
#: <pre>mysqldump --user=wikidb_user --password=wikidb_userpassword wikidb > file.sql </pre>
 +
#: <pre>mysqldump --user=wikidb_user --password=wikidb_userpassword wikidb --xml > file.xml</pre>
 +
#: or if MariaDB is used (which I think it might be)
 +
#: <pre>mariadb-dump --user=wikidb_user --password=wikidb_userpassword wikidb > file.sql </pre>
 +
#: <pre>mariadb-dump --user=wikidb_user --password=wikidb_userpassword wikidb --xml > file.xml</pre>
 +
#: Since this is dockerized, there should be nothing essential to backup from inside the container.
 +
# Need to create a new image with the new MediaWiki version
 +
# Upgrade extensions (if any)
 +
# Adapt LocalSettings.php
 +
#: This might be harder due to VTLUUG using such an old version of MediaWiki
 +
## This includes removing the renameUser Extension
 +
##: <pre>wfLoadExtension( 'Renameuser' );</pre>
 +
# Run the upgrade script
 +
#: <pre>php maintenance/update.php</pre>
 +
 +
 +
 +
  
 
[[Category:VTLUUG:Projects]]
 
[[Category:VTLUUG:Projects]]
 
[[Category:Infrastructure]]
 
[[Category:Infrastructure]]
 
[[Category:Howtos]]
 
[[Category:Howtos]]

Latest revision as of 18:06, 9 December 2024

This page describes how to contribute to this wiki, and things that need to be done as well. Wikipedia's guide has a good overview of contributing, but this page is specific to this Wiki.

A large problem we've had is page and/or category fragmentation and out of date information.

Editing this wiki

  • Don't create a page unless you have a lot to write about. In most cases, this is better suited to be added to an existing page such as Class Software.
  • If you create a page, add it to applicable categories or pages so people actually discover it.
  • Don't create a category unless there are several pages that are in it.
    • People don't navigate the wiki using categories. Instead, use terms you think people will use to search for your page.
  • Explore Existing categories

Things to do

Updating the wiki

This is more for sysadmins than contributors but below are the steps laid out to update this and Gobblerpedia (MediaWiki). This has been taken from the MediaWiki's Upgrade Guide.

  1. Run pending jobs
    php maintenance/runJobs.php
  2. Back up the database, settings, and content
    Basic Instructions
    mysqldump --user=wikidb_user --password=wikidb_userpassword wikidb > file.sql 
    mysqldump --user=wikidb_user --password=wikidb_userpassword wikidb --xml > file.xml
    or if MariaDB is used (which I think it might be)
    mariadb-dump --user=wikidb_user --password=wikidb_userpassword wikidb > file.sql 
    mariadb-dump --user=wikidb_user --password=wikidb_userpassword wikidb --xml > file.xml
    Since this is dockerized, there should be nothing essential to backup from inside the container.
  3. Need to create a new image with the new MediaWiki version
  4. Upgrade extensions (if any)
  5. Adapt LocalSettings.php
    This might be harder due to VTLUUG using such an old version of MediaWiki
    1. This includes removing the renameUser Extension
      wfLoadExtension( 'Renameuser' );
  6. Run the upgrade script
    php maintenance/update.php