diff --git a/docs/architecture-decisions/001-tome.txt b/docs/architecture-decisions/001-tome.txt new file mode 100644 index 000000000..036a27d7e --- /dev/null +++ b/docs/architecture-decisions/001-tome.txt @@ -0,0 +1,30 @@ +Migrate to Tome + +Date: 2025-05-03 + +Status: accepted + +Context: + +The previous version of the website is built with Sculpin, a static site generator written in PHP. + +Whilst it's a great project, I've felt that I've started to outgrow it in some ways and have been thinking about migrating to something else. + +I've been aware of Tome - https://www.drupal.org/project/tome - for a while and it seems like a logical choice for someone who likes both Drupal and static site generators. + +Decision: + +Migrate pages from Sculpin to Drupal/Tome. + +This can be done incrementally and different pages can be served from Sculpin or Tome based on the URL being visited. + +Consequences: + +I can continue to work with familiar tools - e.g. PHP, Drupal, PHPUnit - and don't need to migrate to (or back to) something different like Jekyll, Hugo or Astro. + +Tome will allow me to export the content from Drupal to a static website, the same as Sculpin does, so I'll continue to get the same benefits of a static website, such as performance, security and being easy to host and deploy. + +For consistency, a new theme would need to be created in Drupal so users aren't confused when being served pages from different sources. A lot of the same markup and CSS should be able to be reused. + +As new pages and sections are rebuilt in Drupal/Tome, I can serve these to users by updating the rules in Nginx and incrementally migrate rather than rebuilding and deploying everything at once - making it less risky. + diff --git a/docs/architecture-decisions/002-markdown.txt b/docs/architecture-decisions/002-markdown.txt new file mode 100644 index 000000000..0f6a30730 --- /dev/null +++ b/docs/architecture-decisions/002-markdown.txt @@ -0,0 +1,24 @@ +Use Markdown to add and edit content + +Date: 2025-05-23 + +Status: accepted + +Context: + +Drupal has its own input filters for basic, full and restricted HTML, but doesn't support Markdown out of the box. + +There are contrib modules that can add this functionality, which would make it easier to migrate existing content from Sculpin. + +Decision: + +Install and use the Markdown Easy module - https://www.drupal.org/project/markdown_easy. + +I considered using the Markdown module - https://www.drupal.org/project/markdown - but this is more complicated to set up and there's no current Drupal 11 version. + +Consequences: + +Using the Markdown Easy module will make it easier to create content in Drupal and migrate pages from Sculpin which are written in Markdown. + +I can still use the standard Drupal text formats and CKEditor when needed. +