isle/docs/dev/design-principles.md

# Design Principles

The following points form the basis for all design decisions made within the
Isle project.

* "Sometimes, magic is just someone spending more time on something than anyone
  else might reasonably expect." - Teller

  Isle should feel magical, in that it's making the seemingly impossible feel
  easy. Accomplishing this requires a lot of care, precision, and time on the
  part of Isle developers.

* The UX is aggressively optimized to eliminate manual intervention by members.
  All other concerns are secondary. The concept of "UX" extends beyond GUI
  interfaces, and encompasses all interactions of any sort with an isle
  process.

* All resources within an isle network are expected to be hosted on hardware
  owned by community members, for example home media servers or gaming rigs.
  Thus, an isle network is fully autonomous.

* Hardware resources are expected to be heterogenous and geographically
  dispersed.

* It is expected that a single host might be a part of multiple, independent
  isle networks. These should not conflict with each other, nor share resources.
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`# Design Principles`

			`The following points form the basis for all design decisions made within the`
Perform all in-code renames which don't affect actual functionality 2023-08-05 21:53:17 +00:00			`Isle project.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Write a short document on removing hosts from the network 2024-11-12 15:24:40 +00:00			`* "Sometimes, magic is just someone spending more time on something than anyone`
			`else might reasonably expect." - Teller`

			`Isle should feel magical, in that it's making the seemingly impossible feel`
			`easy. Accomplishing this requires a lot of care, precision, and time on the`
			`part of Isle developers.`

Update documentation 2024-10-03 16:59:48 +00:00			`* The UX is aggressively optimized to eliminate manual intervention by members.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`All other concerns are secondary. The concept of "UX" extends beyond GUI`
Complete in-code changes required by rename 2023-08-07 20:12:51 +00:00			`interfaces, and encompasses all interactions of any sort with an isle`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`process.`

Perform all in-code renames which don't affect actual functionality 2023-08-05 21:53:17 +00:00			`* All resources within an isle network are expected to be hosted on hardware`
			`owned by community members, for example home media servers or gaming rigs.`
Update documentation 2024-07-07 11:37:26 +00:00			`Thus, an isle network is fully autonomous.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
			`* Hardware resources are expected to be heterogenous and geographically`
			`dispersed.`

			`* It is expected that a single host might be a part of multiple, independent`
Perform all in-code renames which don't affect actual functionality 2023-08-05 21:53:17 +00:00			`isle networks. These should not conflict with each other, nor share resources.`