SDSM:Index - Revision history

Darren.duncan: Add new document part Performance Measurements.

2024-09-04T22:25:52Z

Add new document part Performance Measurements.

← Older revision		Revision as of 15:25, 4 September 2024
Line 173:		Line 173:

	See the document part [[SDSM:List_of_Screens\|List of Screens]].		See the document part [[SDSM:List_of_Screens\|List of Screens]].

			[[#top\|RETURN]]

			=== Performance Measurements ===

			See the document part [[SDSM:Performance_Measurements\|Performance Measurements]].

	[[#top\|RETURN]]		[[#top\|RETURN]]

Darren.duncan: Add new document part Users and Privileges which describes kinds of users and lists the LDAP groups.

2024-06-09T01:58:44Z

Add new document part Users and Privileges which describes kinds of users and lists the LDAP groups.

← Older revision		Revision as of 18:58, 8 June 2024
Line 163:		Line 163:

	== User Interface Documentation ==		== User Interface Documentation ==

			=== Users and Privileges ===

			See the document part [[SDSM:Users_and_Privileges\|Users and Privileges]].

			[[#top\|RETURN]]

	=== List of Screens ===		=== List of Screens ===

Darren.duncan: Add link to new SDSM part with a list of SDS user interface screens.

2024-06-04T03:20:42Z

Add link to new SDSM part with a list of SDS user interface screens.

← Older revision		Revision as of 20:20, 3 June 2024
Line 159:		Line 159:

	See the document part [[SDSM:Languages_and_Frameworks\|Languages and Frameworks]].		See the document part [[SDSM:Languages_and_Frameworks\|Languages and Frameworks]].

			[[#top\|RETURN]]

			== User Interface Documentation ==

			=== List of Screens ===

			See the document part [[SDSM:List_of_Screens\|List of Screens]].

	[[#top\|RETURN]]		[[#top\|RETURN]]

Darren.duncan: Add Environment Setup - Software Requirements section, moved back to Index part from Languages and Frameworks part.

2024-05-27T18:10:54Z

Add Environment Setup - Software Requirements section, moved back to Index part from Languages and Frameworks part.

← Older revision		Revision as of 11:10, 27 May 2024
Line 107:		Line 107:

	See the document part [[SDSM:Network_Diagrams\|Network Diagrams]].		See the document part [[SDSM:Network_Diagrams\|Network Diagrams]].

			[[#top\|RETURN]]

			== Environment Setup ==

			=== Software Requirements ===

			'''SDS''' is a web application written in 3 main programming languages:

			* PHP (https://www.php.net)
			* JavaScript
			* MySQL DBMS (https://www.mysql.com) dialect of SQL

			'''SDS''' specifically uses PHP major version 8.1, which was first
			released for general production use on 2020 Nov 26
			(https://www.php.net/ChangeLog-8.php); PHP 8.1 stopped receiving active
			support by its principal maintainers on 2023 Nov 25, and then for
			critical security issues it will only be supported by them until 2025
			Dec 31 (https://www.php.net/supported-versions.php).

			'''SDS''' specifically uses MySQL major version 8.0, which was first
			released for general production use on 2018 Apr 19
			(https://dev.mysql.com/doc/relnotes/mysql/8.0/en/news-8-0-11.html);
			MySQL 8.0 will stop receiving LTS support by its principal maintainers
			in 2026 April.

			'''SDS''' can run on a variety of server environments and operating
			systems, same as PHP and MySQL do. However, its canonical (and ''also''
			its '''Canonical''') runtime environment is the Ubuntu operating system
			(https://ubuntu.com), which '''SMUS''' runs its production and shared
			testing deployments in.

			Those production '''SDS''' deployments specifically use Ubuntu major
			version 22.04 LTS, which was first released for general production use
			on 2022 Apr 21; it will stop receiving standard support in 2027 and end
			of life support in 2032 (https://wiki.ubuntu.com/Releases).

			'''SMUS''' uses the specific versions of PHP and MySQL that are provided
			with the Ubuntu version it uses, so the former are only updated when the
			latter is updated. Most notable is that '''SDS''' is constrained to using
			PHP 8.1 for as long as it is run on Ubuntu 22.04. While their principal
			maintainers may stop supporting those versions sooner, Ubuntu themselves
			would continue to provide critical security and bug fixes to MySQL and PHP
			bundled with their LTS releases, but not new major versions.

	[[#top\|RETURN]]		[[#top\|RETURN]]

Darren.duncan: Add new Network Diagrams section/part.

2024-05-27T05:38:26Z

Add new Network Diagrams section/part.

← Older revision		Revision as of 22:38, 26 May 2024
Line 99:		Line 99:
	be better suited to their needs, or this document can be re-interpreted for		be better suited to their needs, or this document can be re-interpreted for
	them in other forms that better suit them.		them in other forms that better suit them.

			[[#top\|RETURN]]

			== System Architecture ==

			=== Network Diagrams ===

			See the document part [[SDSM:Network_Diagrams\|Network Diagrams]].

	[[#top\|RETURN]]		[[#top\|RETURN]]

Darren.duncan: Split SDSM document part Languages and Frameworks off from Index.

2024-05-27T01:48:56Z

Split SDSM document part Languages and Frameworks off from Index.

Show changes

Darren.duncan: Retitle and sort sections to match Future Layout of SDSM, the latter re-explained as a goal rather an a proposal

2024-05-27T01:30:22Z

Retitle and sort sections to match Future Layout of SDSM, the latter re-explained as a goal rather an a proposal

← Older revision		Revision as of 18:30, 26 May 2024
Line 18:		Line 18:
	[[#top\|RETURN]]		[[#top\|RETURN]]

	== ~~Audience~~ ==		== Introduction ==

	~~The intended audience of this document is individuals who are savvy with~~		=== System Overview ===
	~~electronic computer hardware and software, its use, installation, and~~
	~~maintenance. In particular, it is for individuals that are capable of~~
	~~writing, maintaining, integrating, testing software code, or installing~~
	~~and maintaining deployments of software on internet servers. Or it is~~
	~~for those individuals who directly communicate with or manage such~~
	~~people and technical projects, and have some understanding of technology.~~

	~~This document is mainly for individuals who would be involved with the~~
	~~'''SDS Modernization (SDSM)''' effort, or who would be maintaining~~
	~~'''SDS''' afterwards, or who would be managing the people who do these~~
	~~things, or who want to be more informed about how '''SDS''' works.~~

	~~This document is not specifically for those who are just end users of~~
	~~'''SDS''', or for those who make higher level management decisions and are~~
	~~less technically savvy, but they might glean useful information from it.~~
	~~For these kinds of users, other derived or supplementary documentation may~~
	~~be better suited to their needs, or this document can be re-interpreted for~~
	~~them in other forms that better suit them.~~

	~~[[#top\|RETURN]]~~

	== Overview ==

	'''School Data System (SDS)''' is an electronic records management system		'''School Data System (SDS)''' is an electronic records management system
Line 100:		Line 78:
	[[#top\|RETURN]]		[[#top\|RETURN]]

	== ~~Structure~~ and ~~Dependencies~~ ==		=== Audience of the Documentation ===

			The intended audience of this document is individuals who are savvy with
			electronic computer hardware and software, its use, installation, and
			maintenance. In particular, it is for individuals that are capable of
			writing, maintaining, integrating, testing software code, or installing
			and maintaining deployments of software on internet servers. Or it is
			for those individuals who directly communicate with or manage such
			people and technical projects, and have some understanding of technology.

			This document is mainly for individuals who would be involved with the
			'''SDS Modernization (SDSM)''' effort, or who would be maintaining
			'''SDS''' afterwards, or who would be managing the people who do these
			things, or who want to be more informed about how '''SDS''' works.

			This document is not specifically for those who are just end users of
			'''SDS''', or for those who make higher level management decisions and are
			less technically savvy, but they might glean useful information from it.
			For these kinds of users, other derived or supplementary documentation may
			be better suited to their needs, or this document can be re-interpreted for
			them in other forms that better suit them.

			[[#top\|RETURN]]

			== Codebase Overview ==

			=== Languages and Frameworks ===

	'''SDS''' itself is a web application written mainly in the PHP		'''SDS''' itself is a web application written mainly in the PHP
Line 144:		Line 148:
	[[#top\|RETURN]]		[[#top\|RETURN]]

	=== SDS Laravel PHP Library Dependencies ===		==== SDS Laravel PHP Library Dependencies ====

	==== Directly Used By Name In PHP Source Files ====		===== Directly Used By Name In PHP Source Files =====

	The PHP source code files of ''SDS Laravel'' contain direct references		The PHP source code files of ''SDS Laravel'' contain direct references
Line 241:		Line 245:
	[[#top\|RETURN]]		[[#top\|RETURN]]

	==== Required In Composer Config File ====		===== Required In Composer Config File =====

	The Composer config file <code>composer.json</code> of ''SDS Laravel''		The Composer config file <code>composer.json</code> of ''SDS Laravel''
Line 268:		Line 272:
	[[#top\|RETURN]]		[[#top\|RETURN]]

	==== Resolved From Composer Config File ====		===== Resolved From Composer Config File =====

	When Composer evaluates its config file <code>composer.json</code> of		When Composer evaluates its config file <code>composer.json</code> of
Line 414:		Line 418:
	[[#top\|RETURN]]		[[#top\|RETURN]]

	=== ~~Proposed~~ Layout of SDSM ~~by Chetan Sondagar~~ ===		=== Future Layout of SDSM ===

	~~Chetan Sondagar proposed, on 2024 April 10, the following layout for this~~		The '''SDS Modernization (SDSM)''' document is currently missing a large
	'''SDS Modernization (SDSM)''' document. ~~The actual document layout ended~~		fraction of its intended content. In the meantime, it eschews empty
	~~up being different~~, ~~and the proposal is shown here for posterity~~.		placeholder sections, so one navigating its table of contents can easily
	~~But while~~ the ~~actual~~ document ~~was in development and had substantial~~		discern what does or doesn't exist now. Instead, this current section
	~~missing content, the proposal also served to illustrate what was missing~~.		illustrates the overall layout that the whole document is evolving towards.

	# '''Introduction'''		# '''Introduction'''

Darren.duncan: Add Pending Changes appendix section

2024-05-10T03:42:40Z

Add Pending Changes appendix section

← Older revision		Revision as of 20:42, 9 May 2024
Line 399:		Line 399:

	See the document part [[SDSM:Historical_Changes\|Historical Changes]].		See the document part [[SDSM:Historical_Changes\|Historical Changes]].

			[[#top\|RETURN]]

			=== Pending Changes ===

			See the document part [[SDSM:Pending_Changes\|Pending Changes]].

	[[#top\|RETURN]]		[[#top\|RETURN]]

Darren.duncan at 23:53, 9 May 2024

2024-05-09T23:53:29Z

Darren.duncan: Update enumeration of PHP library dependencies to reflect recent code changes.

2024-05-09T21:17:45Z

Update enumeration of PHP library dependencies to reflect recent code changes.

Show changes

← Older revision		Revision as of 15:25, 4 September 2024
Line 173:		Line 173:

	See the document part [[SDSM:List_of_Screens\|List of Screens]].		See the document part [[SDSM:List_of_Screens\|List of Screens]].

			[[#top\|RETURN]]

			=== Performance Measurements ===

			See the document part [[SDSM:Performance_Measurements\|Performance Measurements]].

	[[#top\|RETURN]]		[[#top\|RETURN]]

← Older revision		Revision as of 20:42, 9 May 2024
Line 399:		Line 399:

	See the document part [[SDSM:Historical_Changes\|Historical Changes]].		See the document part [[SDSM:Historical_Changes\|Historical Changes]].

			[[#top\|RETURN]]

			=== Pending Changes ===

			See the document part [[SDSM:Pending_Changes\|Pending Changes]].

	[[#top\|RETURN]]		[[#top\|RETURN]]

← Older revision		Revision as of 16:53, 9 May 2024
Line 22:		Line 22:
	The intended audience of this document is individuals who are savvy with		The intended audience of this document is individuals who are savvy with
	electronic computer hardware and software, its use, installation, and		electronic computer hardware and software, its use, installation, and
	maintenance. In particular, it is for individuals that are capable of		maintenance. In particular, it is for individuals that are capable of
	writing, maintaining, integrating, testing software code, or installing		writing, maintaining, integrating, testing software code, or installing
	and maintaining deployments of software on internet servers. Or it is		and maintaining deployments of software on internet servers. Or it is
	for those individuals who directly communicate with or manage such		for those individuals who directly communicate with or manage such
	people and technical projects, and have some understanding of technology.		people and technical projects, and have some understanding of technology.
Line 59:		Line 59:

	'''SDS''' has a client-server architecture, hosted on a network as a web		'''SDS''' has a client-server architecture, hosted on a network as a web
	server, and used by way of a web client. '''SDS''' should be compatible		server, and used by way of a web client. '''SDS''' should be compatible
	with all modern web clients, including Mozilla FireFox, Google Chrome,		with all modern web clients, including Mozilla FireFox, Google Chrome,
	Microsoft Edge, and Apple Safari; it should be usable with all modern		Microsoft Edge, and Apple Safari; it should be usable with all modern
Line 82:		Line 82:
	The newer '''SDS''' version is meant to have essentially the same		The newer '''SDS''' version is meant to have essentially the same
	outward-facing or user-visible feature set, behavior, and appearance as		outward-facing or user-visible feature set, behavior, and appearance as
	the older version. The newer version also uses essentially the same SQL		the older version. The newer version also uses essentially the same SQL
	database schema as the older version, and they actively share a database,		database schema as the older version, and they actively share a database,
	which makes for a more seamless migration as the database doesn't have to		which makes for a more seamless migration as the database doesn't have to
	be "converted". Within these constraints of looking the same to users and		be "converted". Within these constraints of looking the same to users and
	having the same database, the new version is almost completely different		having the same database, the new version is almost completely different
	internally, with a new internal code structure that is a lot more modern.		internally, with a new internal code structure that is a lot more modern.

	Each '''SDS''' version is written in the '''PHP''' programming language		Each '''SDS''' version is written in the '''PHP''' programming language
	and uses a '''MySQL''' database. The newer version uses the		and uses a '''MySQL''' database. The newer version uses the
	'''Laravel''' PHP application framework, while the older version uses		'''Laravel''' PHP application framework, while the older version uses
	the '''Gavintech''' PHP framework. Both versions' production instances		the '''Gavintech''' PHP framework. Both versions' production instances
	are on servers running the '''Ubuntu''' operating system and are behind		are on servers running the '''Ubuntu''' operating system and are behind
	an '''Apache''' web server. While '''Gavintech''' is essentially		an '''Apache''' web server. While '''Gavintech''' is essentially
	abandoned, very non-modern, and bespoke, all of the other named		abandoned, very non-modern, and bespoke, all of the other named
	dependencies are actively maintained, modern, and very popular.		dependencies are actively maintained, modern, and very popular.
Line 103:		Line 103:

	'''SDS''' itself is a web application written mainly in the PHP		'''SDS''' itself is a web application written mainly in the PHP
	programming language (https://www.php.net). Some portions are also		programming language (https://www.php.net). Some portions are also
	written in the JavaScript programming language, though it is intended		written in the JavaScript programming language, though it is intended
	that these will be replaced with PHP code, mostly if not entirely.		that these will be replaced with PHP code, mostly if not entirely.
Line 124:		Line 124:

	'''SDS''' can run on a variety of server environments and operating		'''SDS''' can run on a variety of server environments and operating
	systems, same as PHP and MySQL do. However, its canonical (and ''also''		systems, same as PHP and MySQL do. However, its canonical (and ''also''
	its '''Canonical''') runtime environment is the Ubuntu operating system		its '''Canonical''') runtime environment is the Ubuntu operating system
	(https://ubuntu.com), which '''SMUS''' runs its production and shared		(https://ubuntu.com), which '''SMUS''' runs its production and shared
Line 136:		Line 136:
	'''SMUS''' uses the specific versions of PHP and MySQL that are provided		'''SMUS''' uses the specific versions of PHP and MySQL that are provided
	with the Ubuntu version it uses, so the former are only updated when the		with the Ubuntu version it uses, so the former are only updated when the
	latter is updated. Most notable is that '''SDS''' is constrained to using		latter is updated. Most notable is that '''SDS''' is constrained to using
	PHP 8.1 for as long as it is run on Ubuntu 22.04. While their principal		PHP 8.1 for as long as it is run on Ubuntu 22.04. While their principal
	maintainers may stop supporting those versions sooner, Ubuntu themselves		maintainers may stop supporting those versions sooner, Ubuntu themselves
	would continue to provide critical security and bug fixes to MySQL and PHP		would continue to provide critical security and bug fixes to MySQL and PHP
Line 150:		Line 150:
	The PHP source code files of ''SDS Laravel'' contain direct references		The PHP source code files of ''SDS Laravel'' contain direct references
	to a variety of third-party PHP classes, most instances of which are		to a variety of third-party PHP classes, most instances of which are
	parts of the Laravel framework, and some that aren't. Often their		parts of the Laravel framework, and some that aren't. Often their
	fully-qualified names only appear on the form of <code>use</code>		fully-qualified names only appear on the form of <code>use</code>
	statements but other times those names ''don't'' appear in		statements but other times those names ''don't'' appear in
Line 411:		Line 411:

	Chetan Sondagar proposed, on 2024 April 10, the following layout for this		Chetan Sondagar proposed, on 2024 April 10, the following layout for this
	'''SDS Modernization (SDSM)''' document. The actual document layout ended		'''SDS Modernization (SDSM)''' document. The actual document layout ended
	up being different, and the proposal is shown here for posterity.		up being different, and the proposal is shown here for posterity.
	But while the actual document was in development and had substantial		But while the actual document was in development and had substantial