feat: Add Vert.x based Telestion deprecation warning / information ab…

…out moving to TypeScript

docs/application/index.mdx

@@ -4,6 +4,11 @@ title: Application Development
 
 import { Grid, Reference } from '/components';
 
+import ApplicationDeprecationWarning from '/src/components/application-deprecation-warning.mdx';
+
+<ApplicationDeprecationWarning />
+
+
 The _Application_ is the backend of the Telestion ecosystem and based on Java
 (or, more generally speaking, the Java Virtual Machine).
 

docs/client/tutorials/220-connecting-with-event-bus.mdx

@@ -48,6 +48,11 @@ Example with npm articles:
 
 import { Reference, Image } from '/components';
 
+import ApplicationDeprecationWarning from '/src/components/application-deprecation-warning.mdx';
+
+<ApplicationDeprecationWarning />
+
+
 <!-- Short description of what the article covers: -->
 
 In this tutorial, you'll extend your widget from the

docs/common-concepts/application.mdx

@@ -38,6 +38,11 @@ Guide: Interacting with the Event Bus
 
 import { Reference, Image } from '/components';
 
+import ApplicationDeprecationWarning from '/src/components/application-deprecation-warning.mdx';
+
+<ApplicationDeprecationWarning />
+
+
 <!-- Brief Description (1-3 lines) of the concept: -->
 
 The Application is a Java-based software (using the Vert.x framework)

docs/common-concepts/event-bus.mdx

@@ -40,6 +40,11 @@ Guide: Interacting with the Event Bus
 
 import { Reference, Image } from '/components';
 
+import ApplicationDeprecationWarning from '/src/components/application-deprecation-warning.mdx';
+
+<ApplicationDeprecationWarning />
+
+
 <!-- Brief Description (1-3 lines) of the concept: -->
 
 The Event Bus is, basically, the nervous system of the Telestion Ecosystem. The

docs/index.mdx

@@ -7,6 +7,10 @@ import { Reference, Grid, Image } from '/components';
 
 Welcome to the Telestion Documentation pages.
 
+import ApplicationDeprecationWarning from '/src/components/application-deprecation-warning.mdx';
+
+<ApplicationDeprecationWarning />
+
 Telestion is an extensible, open source ecosystem for building Ground Station
 Software. It's based on Java for the backend and React on the frontend side.
 

docs/vertx-based-telestion-deprecation.mdx

@@ -0,0 +1,8 @@
+---
+sidebar_position: 2
+title: Telestion is moving to TypeScript
+---
+
+import ApplicationDeprecationWarning from '/src/components/application-deprecation-warning.mdx';
+
+<ApplicationDeprecationWarning />

docusaurus.config.js

@@ -14,6 +14,16 @@ module.exports = {
 	organizationName: 'wuespace', // Usually your GitHub org/user name.
 	projectName: 'telestion-docs', // Usually your repo name.
 	themeConfig: {
+		announcementBar: {
+			id: 'move-to-typescript',
+			content: `
+				Telestion is moving to TypeScript! Writing Telestion applications in Java is now deprecated.
+				Find more information about what this means for you <a href="/vertx-based-telestion-deprecation/">on this page</a>.
+				`,
+			backgroundColor: 'red',
+			textColor: '#fff',
+			isCloseable: false
+		},
 		navbar: {
 			title: 'Telestion Docs',
 			logo: {

sidebars.js

@@ -46,6 +46,7 @@ const genCategory = (
 module.exports = {
 	docs: [
 		'index',
+		'vertx-based-telestion-deprecation',
 		genCategory(
 			'common-concepts',
 			'Common Concepts',

src/components/application-deprecation-warning.mdx

@@ -0,0 +1,27 @@
+:::warning Deprecated: Vert.x-based Telestion
+
+Please note that the application and development of backend services using Vert.x in Telestion are deprecated. In the future, Telestion backend services will be developed using TypeScript and Deno, or through custom integrations with other languages.
+
+While there may be a compatibility layer for Vert.x services in the future, its availability is not guaranteed.
+
+For developing backend services, please refer to the (Work-in-Progress) documentation available here: [https://pklaschka.github.io/telestion-docs-new/](https://pklaschka.github.io/telestion-docs-new/). Once the documentation is complete, it will be moved to the main Telestion documentation.
+
+Additional Information:
+- NATS will be used as the distributed message bus/message broker for Telestion.
+- NATS' integrated authentication and authorization features will handle authentication and authorization for Ground Station operators, providing a single source of truth.
+- The event bus bridge will no longer be featured, and clients will be directly connected to the NATS server.
+
+To establish a more technology-independent terminology, the Telestion project will modify the naming conventions as follows:
+- The NATS server will be referred to as the message broker, message bus, or NATS server interchangeably.
+- Components that act as services without an attached user interface, will be referred to as services or backend services collectively.
+- Components that provide a user interface, formerly known as "clients," will be referred to as frontends. In most cases, the frontend will authenticate to the message broker as the user, while backend services will act on their own behalf.
+
+These changes aim to provide clearer and more consistent terminology, accounting for the possibility of components having both service and frontend functionalities. Additionally, the use of "client" for frontends will be replaced to avoid potential confusion.
+
+We recommend using the NATS client libraries recommended by NATS itself, unless there are no suitable options available for the targeted language/environment. We will not develop our own client libraries unless there is a lack of suitable options or significant advantages justify the effort.
+
+While Deno/TypeScript is the recommended choice for backend services, its use is not mandatory. Developers will be encouraged to use Deno/TypeScript where appropriate, but other options will still be supported for specific services. Comprehensive documentation and resources will be provided for writing and deploying Deno-based backend services in TypeScript.
+
+Please consider these changes and updates as you continue with Telestion development.
+
+:::

src/components/index.js

@@ -2,3 +2,4 @@ export * from './Grid';
 export * from './Reference';
 export * from './FileDownload';
 export * from './Image';
+export * from './application-deprecation-warning.mdx';