Difference between revisions of "Introduce a new developer to Organic Design"

From Organic Design wiki
(Organic Design Procedures: comments)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{legacy|Development guidelines}}
 
{{procedure
 
{{procedure
 
  | role = sysop
 
  | role = sysop
Line 5: Line 6:
  
 
== Wiki/Wikia configuration ==
 
== Wiki/Wikia configuration ==
Most of the settings required are already configured in the [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2Fwikia.php wikia.php] script in out ''extensions' svn repo, but some settings such as the wiki's name, its database details and its extensions are still necessary. See our sample file [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2FLocalSettings.sample.php LocalSettings.sample.php] which covers most of the common conventions for a wiki intended for Organic Design wiki organisation use. One other related file is [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2Fwikia.i18n.php wikia.i18n.php] which contains all the internationalised messages used by OD wiki organisational systems. See the [[install a new organisational system]] for more detail.
+
Most of the settings required are already configured in the [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2Fwikia.php wikia.php] script in out ''extensions' svn repo, but some settings such as the wiki's name, its database details and its extensions are still necessary. See our sample file [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2FLocalSettings.sample.php LocalSettings.sample.php] which covers most of the common conventions for a wiki intended for Organic Design wiki organisation use. One other related file is [http://svn.organicdesign.co.nz/filedetails.php?repname=extensions&path=%2Fwikia.i18n.php wikia.i18n.php] which contains all the internationalised messages used by OD wiki organisational systems. See the [[install a new wiki]] for more detail.
 
 
  
 
== Organic Design Servers & Packages ==
 
== Organic Design Servers & Packages ==

Latest revision as of 21:28, 15 September 2019

Legacy.svg Legacy: This article describes a concept that has been superseded in the course of ongoing development on the Organic Design wiki. Please do not develop this any further or base work on this concept, this is only useful for a historic record of work done. You may find a link to the currently used concept or function in this article, if not you can contact the author to find out what has taken the place of this legacy item.

Please refer to Development guidelines instead.

Procedure.svg Introduce a new developer to Organic Design
Organic Design procedure

Wiki/Wikia configuration

Most of the settings required are already configured in the wikia.php script in out extensions' svn repo, but some settings such as the wiki's name, its database details and its extensions are still necessary. See our sample file LocalSettings.sample.php which covers most of the common conventions for a wiki intended for Organic Design wiki organisation use. One other related file is wikia.i18n.php which contains all the internationalised messages used by OD wiki organisational systems. See the install a new wiki for more detail.

Organic Design Servers & Packages

All our servers are installed with the install a new server procedure which starts with the installation of the organicdesign-server package and then takes you through configuration of Apache/PHP/MySQL and our Wikia structure. After that a number of other more specific procedures can be carried out which are described below.

The organicdesign-server package is in our packages.organicdesign.co.nz/main repository along with the organicdesign-workstation package which is used to install workstations to be used by members running our organisational system. To update tehse packages, see the Create or Update a Debian package procedure.

Later we like to be able to maintain our own tree of distro's all based on the server and workstation packages which are preloaded with our own software and content and exhibit a simple setup procedure to create the initial configuration structure.

Organic Design Procedures

The most important set of procedures is the sysop procedures, and out of these the most key ones are:

Organic Design Code

Our Subversion repos at svn.organicdesign.co.nz contain all our code, only the extensions and tools repo's are active. The extensions repo contains all the MediaWiki extensions we maintain which are not popular enough to be in the official MediaWiki repo. See the configure SVN procedure for details about our Subversion setup and how to access it. The tools repo contains all our server tools and robot framework mainly written in Perl. Here's a quick run down of the important scripts and files:

  • add-db - a script for adding a new MediaWiki database to MySQL from a template database dump
  • dovecot-cert.sh - create/update the self-signed cert for the local Dovecot installation
  • jobs - specialised jobs can be created which run in the background
  • firewall.sh - template for a basic firewall for LAN-based servers
  • wiki.pl - our script for interacting with MediaWiki's via HTTP
  • wikid.pl - our main robot/daemon script, see wiki daemon for more detail
  • wikid.conf.sample - sample configuration file for Wikia/robot framework

Useful links about Organic Design in general