CHANGELOG.md

Changelog

2.9.1 (2022-05-27)

Bug Fixes

• docs/application: Fix git command for squashing a commit for ZSH (727513f), closes #216

2.9.0 (2022-04-29)

Features

• docs/application: Add asynchronous coding guide (4073c64)
• docs/application: Add Verticle event loop concept (b2c95be)
• images: Add Future compose diagram (d6b30a5)
• images: Add Future eventually diagram (93d120a)
• images: Add future map diagram (569b05a)
• images: Add Future recover diagram (6be062a)
• images: Add Future transform diagram (1f2d021)
• images: Add Java thread distribution diagram (319f830)
• images: Add Promise states diagram (cd2bbf2)
• images: Add Verticle event loop diagram (d92c5ab)

2.8.0 (2022-03-17)

Features

• docs/application: ✨ Add reference of prerequisites for Application development (7dba3fa), closes #116
• docs/client: ✨ Add reference of prerequisites for Client development (1e6d8f6), closes #116

Bug Fixes

• 🚑 Fix broken links of empty categories with placeholder "Coming soon" pages (02d169b)
• docs/application: 🎨 Fix grammar and writing style issues in Deployment tutorial (381f09f)
• docs/application: 🎨 Fix writing style issues in "Starting a new Project" tutorial (c426aa0)
• docs/internal: 🩹 Fix wording on "Internal Tutorials" category overview page (7c24fd5)

2.7.1 (2022-03-05)

Bug Fixes

• docs/application: Fix code formatting issue in a <Reference /> (891db72)
• docs/application: Fix code formatting issue in a <Reference /> (7f25812)

2.7.0 (2022-03-04)

Features

• application: Add deployment tutorial (0703b84)
• application: Add manual steps to initialize a Telestion Project (e5db14e)
• docs/application: 🚸 Improve the Verticle concept article (f0b99b1)
• docs/application: ✨ Add Java Records concept (b9538fc), closes #164
• docs/client: 🚸 Improve Telestion Client CLI concept (e9999b1)
• docs/client: ✨ Add "TypeScript" concept (18f9f39), closes #182
• docs/client: ✨ Add React concept (d0690fe), closes #181
• docs/client: ✨ Add tutorial about adding configuration options to Telestion Client Widgets (3e87ce3), closes #152
• docs/general: 🚸 Add more details to general audience Client concept (a3f7196)
• docs/general: 🚸 Add more details to the general audience Application concept (7f97dcc)
• docs/general: ✨ Add "Application" concept article for general audiences (e145674)
• docs/general: ✨ Add "Client" concept article for general audiences (338d99d)
• docs/general: ✨ Add general audience "Event Bus" concept (e3378ee), closes #151
• docs/general: 🚚 Improve information architecture with more specialized, less cluttered navigation menus (6e2ab70), closes #86
• stylesheet: 💄 Add dark mode support (5390a8c)

Bug Fixes

• docs/application: Replace deprecated GenericConfiguration class with designated replacement (856df60)
• docs/client: 🐛 Fix syntax highlighting for .tsx file code blocks (91b7d73)
• docs/internal: Improve dark mode support in conventional commit diagram (cf9b284)
• images: 🐛 Remove old reference to "PSC" in Event Bus Bridge Diagram (8a50959)

2.6.3 (2022-02-04)

Bug Fixes

• docs/application: Fix configuration base interfaces (962c711)

2.6.2 (2022-02-03)

Bug Fixes

• docs/application: Fix formatting in "Using Traits in Verticles" tutorial (58b44ff)
• docs/general: 🩹 Fix more language inconsistencies (ed91fa8)
• docs/general: 🩹 Fix various language inconsistencies (4dec5a0)
• docs/internal: 🐛 Fix typo in Error Messages Concept (eb93e41)

2.6.1 (2022-01-31)

Bug Fixes

• deployment: 🚑 Fix scroll lock issue on Chrome/Windows 10 (09cc6f5)

2.6.0 (2022-01-31)

Features

• docs/application: Add concept describing traits in Java (5fd219d)
• docs/application: Add concept describing traits in Java (4e916dc)
• docs/application: Add tutorial on how to use traits in Verticles (9774def)
• docs/application: Add tutorial on how to use traits in Verticles (79b7175)
• docs/application: Update adding configuration options tutorial to use the new TelestionVerticle class (eaa9bf6)
• docs/application: Update adding configuration options tutorial to use the new TelestionVerticle class (1b51bc9)
• docs/application: Update using json message tutorial to use the new TelestionVerticle class (66cb81d)
• docs/application: Update using json message tutorial to use the new TelestionVerticle class (d3bb94c)
• docs/application: Update verticle concept to use the new TelestionVerticle class (9e6896f)
• docs/application: Update verticle concept to use the new TelestionVerticle class (22c3559)
• docs/application: Update writing a verticle tutorial to use the new TelestionVerticle class (72b5bbc)
• docs/application: Update writing a verticle tutorial to use the new TelestionVerticle class (79b2a3d)
• docs/client: ✨ Add Electron concept (646fdae), closes #150
• docs/client: Add guide on how to write own traits (bb02da0)
• docs/client: Add guide on how to write own traits (bd065f6)
• docs/client: Add tutorial about writing a stateful dialog (e4ea70b)
• docs/client: Add tutorial about writing a static dialog (f5999fb)
• docs/client: Add tutorials to index page (e211b01)
• Move to new domain https://docs.telestion.wuespace.de/ (9d250d4)
• Overall language improvements (and adding vale as a prose linter to enforce it) (0543b0c)
• Rework sidebar configuration and add API reference links (7a44014)

2.5.0 (2022-01-15)

Features

• docs/client: 🚸 Add note about telestion-project-template usage of tc-cli init (ead9603)
• docs/client: 🚸 Add note about restarting the development server after plugin changes (172a1d9)
• docs/client: ✨ Add client tutorials index page (a72c39c)
• docs/client: ✨ Add tutorial on bootstrapping a widget (db91a88)
• docs/client: ✨ Add tutorial on building the widget's UI using React Spectrum (54ce83e)
• docs/client: ✨ Add tutorial on using the event bus hooks from @wuespace/telestion-client-core to connect the widget to the event bus (68d4258)
• docs/general: 🚑 Add a proper homepage (18a2a41)

Bug Fixes

• docs/client: 🐛 Add missing tutorials reference to client index page (a51424c)
• docs/client: 🐛 Fix a few grammatical inconsistencies (59acf2b)
• docs/client: 🚚 Rename Development Environment Setup tutorial tutorial to dev-env-setup (17a6117)

2.4.0 (2021-12-23)

Features

• docs/client: 📝 Add development environment setup tutorial (#128) (19706ce)
• docs/internal: ✨ Add documentation/guiedlines on writing good error/exception messages in our libraries. (#137) (e41b6bf)

2.3.0 (2021-12-17)

Features

• docs/general: 🏗️ Add category index pages to public documentation pages (ee30bef)

Bug Fixes

• docs/application: Fix a small typo (5e22acf)
• docs/general: 🩹 Fix concept topic order (7547833)

2.2.1 (2021-11-21)

Bug Fixes

• deployment: 🚑 Force trailing slashes for better GitHub pages support (239d5d4)

2.2.0 (2021-11-21)

Features

• application: Add a tutorial to start a new Telestion project (a3143d3)
• docs/application: ✨ Add tutorial about using the JsonMessage inteface (29fdcb9)
• docs/application: ✨ Add tutorial for adding configuration options to Verticles (f54a162)
• docs/application: ✨ Fill out (i.e., actually write) the "Writing a Verticle" tutorial (405335f)
• images: 🍱 Add event bus bridge explanation diagram to assets (d9ff906)
• images: 🍱 Add event bus explanation diagram to assets (0ea91cc)
• images: 🍱 Add general Telestion structure overview diagram to assets (e2a1fcd)
• stylesheet: 💄 Make it possible to center images (d505b2f)

Bug Fixes

• docs/application: 🐛 Add missing reference to Backend Tutorials overview page (dfc7694)

2.1.0 (2021-08-31)

Features

• ✨ Add information architecture problem issue form (e545f31)
• ✨ Add missing/incomplete documentation issue form (626b31f)
• components: ✨ Add <Image /> component for more consistent image handling (cfa8097)
• docs/internal: ✨ Add an interactive branch name calculator to the branch names reference (3bcd22f)
• templates: 🌱 Include <Image /> component import by default in all templates (d8ff855)

2.0.0 (2021-08-16)

⚠ BREAKING CHANGES

• Setup "Docusaurus 2"-based documentation

Features

• 🔧 Add ebnf as highlighted language within docusaurus.config.js (e8c9851), closes #79
• Add "Reviewing and Merging Pull Requests" task for telestion-client repo (3b6f795)
• components: ✨ Add <FileDownload /> component (8fe4529)
• deployment: 🚀 Deploy to GitHub Pages (c9299ef), closes #85
• docs/client: 📝 Add nodejs.mdx concept (42d0549), closes #79
• docs/client: 📝 Add npm concept (9b07597), closes #79
• docs/client: 📝 Add tc-cli concept and general client documentation category (d7a3b72), closes #79
• docs/client: 📝 Add external resources to tc-cli.mdx (56425d9)
• docs/internal: 📝 Add branch naming reference (1db51d2), closes #79
• docs/internal: 📝 Add conventional commit type reference (14a7dbc), closes #79
• docs/internal: 📝 Add conventional commits concept (dcb653b), closes #79
• docs/internal: 📝 Add key git principles reference (2a03f2a), closes #79
• docs/internal: 📝 Add Maintainer's tasks reference (81b5abd), closes #79
• docs/telestion-client-internal: 📝 Add lerna concept and general telestion-client-internal documentation section (e9d983e), closes #79
• Setup "Docusaurus 2"-based documentation (016b1bb), closes #80
• templates: 🌱 Add category folder template _templates/category (0014d0c)
• templates: 🌱 Add concept article template _templates/concept.mdx (1a89f8e), closes #79
• templates: 🌱 Add guide article template _templates/guide.mdx (a196040), closes #79
• templates: 🌱 Add reference article template _templates/reference.mdx (27e301a), closes #79
• templates: 🌱 Add tutorial article template _templates/tutorial.mdx (0f1ec17), closes #79
• templates: 🌱 Improve "Meta Template" (template for templates) (558afd1), closes #79
• templates: 🌱 Make meta template more useful _templates/_meta-template.mdx (72ebeb7)

Bug Fixes

• 🔧 Fix "Edit this page" link base url (cb8d562)
• docs/client: 🔍 Add SEO description to tc-cli.mdx (8f09b16)
• docs/general: 🐛 Fix broken links in intro.mdx (934f0ac)
• docs/internal: ✏️ Fix typo in conventional commit types diagram (8365829)
• stylesheet: 🔥 Remove unneeded, commented out piece of CSS (7b37ce9)