update Project documentation and Online resources

[freephile]

The Meza project is undergoing an upgrade and as the project has sprawled across multiple sites and repositories, it's time to clean up these resources to provide more accurate information to would-be users, contributors, and developers alike.

1. NASA GRC (Sandusky, OH) Meza repo https://github.com/nasa/meza
2. Andy Rechenberg (DJFlux) Meza 1.35 on Rocky https://github.com/djflux/meza/ (this work is contained in the GRC repo)
3. NASA JSC (Houston, TX) Meza repo https://github.com/enterprisemediawiki/meza
4. Greg Rundlett (Freephile) Meza repo (development) https://github.com/freephile/meza
5. Meza on MediaWiki.org https://www.mediawiki.org/wiki/Meza

[freephile]

Level 1 Organization

Aligning existing online resources

Updating enterprisemediawiki and freephile githubs to point clearly to the nasa repo

Expose Institutional requirements

All documentation efforts should be guided by the institutional requirements of NASA.
cf https://nodis3.gsfc.nasa.gov/displayDir.cfm?t=NPR&c=7150&s=2B (Chapter 6 documentation)

Level 2 Updating existing content for accuracy, relevancy, and audience

The documentation at MediaWiki.org needs editorial review.

Examples:

• "Meza installs MediaWiki 1.31" should be 1.39
• Meza/Extensions installed by default carries an 'out of date' warning.
• etc.
• we could compile a list, or just attack it

Level 3 Gaps

There are some pretty obvious documentation gaps that would help the community. For instance, how is Memcached used in Meza? All major components from Ansible to Memcached, VirtualBox, GitHub and the CMTE should have some documentation. The test sites should be linked and visible (maybe they are?)

[freephile]

Some Level 2 progress

I made some edits to the Meza page on mwo

I redesigned the 'sub pages' section and added a search box.

Now the list of subpages are created using SpecialPage transclusion - making them a bit more useful (via parameters) and cleaner in the wiki markup.

The links in the section are alphabetized for quick visual scanning.

The external link to GitHub issues is separated out.

I added a InputBox fulltext search box at the top so users can quickly find out if there is anything about e.g. 'ansible playbook' within the Meza documentation.

Part of the motivation for this was to find out if there was anything currently documented on how to run Meza Ansible playbooks using the --check option for testing.

So, now it is simple to run searches like this from the Meza page.

[freephile]

Level 3 work

Document each role

• apache-php
• autodeployer
• backup-config
• backup-db-wikis
• backup-db-wikis-push
• backups-cleanup
• backup-uploads
• backup-uploads-push
• base
• base-config-scripts
• base-extras
• composer
• configure-wiki
• create-wiki-wrapper
• cron
• database
• delete-wiki-wrapper
• develop
• dump-db-wikis
• elasticsearch
• enforce-meza-version
• firewalld
• firewall_port
• firewall_service
• gluster
• haproxy
• htdocs
• imagemagick
• init-controller-config
• key-transfer
• lua
• mediawiki
• memcached
• meza-log
• netdata
• remote-dir-check
• remote-mysqldump
• rsync
• rsync-push
• saml
• setup-env
• set-vars
• sql-backup-cleanup
• sync-configs
• umask-set
• umask-unset
• update.php
• verify-wiki

[freephile]

Level 3 Work

Document each playbook

• backup
• check-for-changes
• cleanup-upload-stash
• create-wiki-promptless
• create-wiki
• delete-elasticsearch
• delete-wiki-promptless
• delete-wiki
• deploy-notify
• elasticsearch-upgrade
• getdocker
• push-backup
• rebuild-smw-and-index
• setbaseconfig
• setup-env
• site

[freephile]

Level 3 Work

Document each script

• check_my_jinja.py
• checkUpgrade.php
• create-vm.sh
• dev-networking.sh
• do-release.sh
• getmeza.sh
• importExtensions.php
• kickstart
• merge-pages
• meza.py
• shell-functions
• ssh-users
• ssl-selftest.sh
• unifyUserTables.php
• uniteTheWikis.php
• unite-the-wikis.sh
• YamlDiff.php

[freephile]

Level 2 Work

Update Meza Documentation Pages on MediaWiki.org

1. All Meza subpages
2. Chronological search - newest first so that the stale information can be found and updated.

• Adding wikis
• All sub pages
• All talk sub pages
• Autodeployer
• Cloning VirtualBox VMs
• Commands
• Commands/list-tags
• Commands/list-tasks
• Common Meza Test Environment (CMTE)
• Configuration options
• Deploy
• Development
• Directory structure
• Emulate the Travis CI test setup
• Ensuring users get the latest file
• Enterprise Application Requirements
• ExtensionList
• Extension Installation Community Cheat-Sheet
• Extensions installed by default
• FAQ
• Glossary
• Importing data
• Install on Virtual Box
• Install on Wikimedia Cloud VPS instance
• Install on existing server
• Install on multiple servers
• Install with Vagrant
• Installing additional extensions
• Installing additional skins
• Known Enterprise Challenges
• NASA Technology Report for MEZA (NTR 1654188037)
• Notes on Implementing a Pywikibot
• Performance monitoring
• Periodic Cron jobs
• Public config
• Rebuild SMW data and search index
• Requirements
• RockyLinuxKickstart
• Scripts
• Secret config
• SemanticApprovedRevs
• Setting up a Cross-Site Notifications
• Setting up a common uploads wiki
• Setup Elasticsearch plugins
• Setup SAML authentication
• Setup a RedHat VM
• Setup on a low-memory system
• Short procedure on how to submit a PR to Meza
• Upgrade Meza
• Upgrade from Meza 27.x
• Version history
• per site access and read permissions