Add or enhance meta titles and descriptions (#4019)

* Add or enhance meta title and meta description of the article pages of the latest docs version: Building Apps -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Components -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Contributing -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Control Center -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Flow -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Getting Started -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Hilla -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Tools -section * Add or enhance meta title and meta description of the article pages of the latest docs version: Styling -section * Add or enhance meta title and meta description of the article pages of the latest docs version: compatibility, upgrading and documentation root pages * Fix some vale errors * Update local-environment.adoc * Fix vale errors --------- Co-authored-by: Veera Paananen <[email protected]> Co-authored-by: Petter Holmström <[email protected]>
vaadin · Dec 19, 2024 · 472f9b3 · 472f9b3
1 parent 460532f
commit 472f9b3
Show file tree

Hide file tree

Showing 669 changed files with 1,440 additions and 118 deletions.
diff --git a/.github/styles/config/vocabularies/Docs/accept.txt b/.github/styles/config/vocabularies/Docs/accept.txt
@@ -42,6 +42,7 @@ Dockerfile
 [dD]ompurify
 # Vale spelling doesn't recognize "dos and don'ts"
 don'ts
+[dD]ownscaling
 [dD]rag-and-[dD]rop
 [dD]raggable
 Dragonfly

diff --git a/articles/building-apps/application-layer/application-services.adoc b/articles/building-apps/application-layer/application-services.adoc
@@ -1,6 +1,8 @@
 ---
 title: Application Services
+page-title: How to design and manage application services in Vaadin
 description: How to design application services.
+meta-description: Discover how to structure and manage application services in your Vaadin application for a scalable and maintainable architecture.
 order: 10
 ---
 

diff --git a/articles/building-apps/application-layer/domain-primitives.adoc b/articles/building-apps/application-layer/domain-primitives.adoc
@@ -1,6 +1,8 @@
 ---
 title: Domain Primitives
-description: Learn what are domain primitives and how to use them in applications.
+page-title: How to use domain primitives in Vaadin applications
+description: Learn what domain primitives are and how to use them in applications.
+meta-description: Learn what domain primitives are and how you can use them in your Vaadin applications for better structure and logic. 
 order: 28
 ---
 

diff --git a/articles/building-apps/application-layer/index.adoc b/articles/building-apps/application-layer/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Application Layer
+page-title: How to build the application layer of your Vaadin app
 description: How to build the application layer of Vaadin applications.
+meta-description: Learn about the application layer in Vaadin apps. Explore its role in structuring business logic, handling interactions, and ensuring scalable architecture.
 order: 40
 ---
 

diff --git a/articles/building-apps/application-layer/persistence/flyway.adoc b/articles/building-apps/application-layer/persistence/flyway.adoc
@@ -1,6 +1,8 @@
 ---
 title: Flyway
+page-title: Database migration with Flyway in Vaadin applications
 description: How to manage your relational database schema with Flyway.
+meta-description: Learn how you can manage your relational database schema and database migrations with Flyway in your Vaadin applications.
 order: 30
 ---
 

diff --git a/articles/building-apps/application-layer/persistence/index.adoc b/articles/building-apps/application-layer/persistence/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Persistence
+page-title: How to design the persistence layer in Vaadin applications
 description: How do handle persistence in Vaadin applications.
+meta-description: Learn how to build and integrate a robust persistence layer in Vaadin apps. Follow best practices for data storage, retrieval, and ORM frameworks.
 order: 40
 ---
 

diff --git a/articles/building-apps/application-layer/persistence/repositories/index.adoc b/articles/building-apps/application-layer/persistence/repositories/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Repositories
+page-title: Managing repositories in the persistence layer | Vaadin
 description: How to use repositories to store and fetch data.
+meta-description: Explore best practices for managing repositories in the persistence layer of your Vaadin applications. Learn how to store and fetch data using repositories.
 order: 10
 ---
 

diff --git a/articles/building-apps/application-layer/persistence/repositories/jooq.adoc b/articles/building-apps/application-layer/persistence/repositories/jooq.adoc
@@ -1,6 +1,8 @@
 ---
 title: jOOQ Repositories
+page-title: How to use jOOQ with Vaadin repositories
 description: How to implement repositories with jOOQ.
+meta-description: Leverage jOOQ and learn how to implement repositories with it for efficient data access and management in your Vaadin applications.
 order: 30
 ---
 

diff --git a/articles/building-apps/application-layer/persistence/repositories/jpa.adoc b/articles/building-apps/application-layer/persistence/repositories/jpa.adoc
@@ -1,6 +1,8 @@
 ---
 title: JPA Repositories
+page-title: How to use JPA repositories in Vaadin
 description: How to implement repositories with JPA and Spring Data.
+meta-description: Integrate JPA repositories in Vaadin applications for advanced persistence capabilities.
 order: 20
 ---
 

diff --git a/articles/building-apps/application-layer/persistence/repositories/pluggable.adoc b/articles/building-apps/application-layer/persistence/repositories/pluggable.adoc
@@ -1,6 +1,8 @@
 ---
 title: Pluggable Persistence
+page-title: How to create pluggable repositories in Vaadin
 description: How to support multiple persistence solutions with a single SPI.
+meta-description: Implement pluggable repositories in Vaadin for flexible and scalable data persistence.
 section-nav: hidden
 order: 40
 ---

diff --git a/articles/building-apps/architecture/components.adoc b/articles/building-apps/architecture/components.adoc
@@ -1,6 +1,8 @@
 ---
 title: System Components
+page-title: How to use system components in Vaadin architecture
 description: Learn more about System Components and how to turn them into Java code.
+meta-description: Learn how to integrate and manage components in Vaadin's architectural framework.
 order: 20
 ---
 

diff --git a/articles/building-apps/architecture/design.adoc b/articles/building-apps/architecture/design.adoc
@@ -1,7 +1,8 @@
 ---
 title: Design
-page-title: Designing the Architecture
+page-title: Application design architecture | Vaadin
 description: Explains how to use the C4 model to design architecture.
+meta-description: Discover design principles for creating scalable and maintainable applications with Vaadin.
 order: 10
 ---
 

diff --git a/articles/building-apps/architecture/index.adoc b/articles/building-apps/architecture/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Architecture
+page-title: How to structure the architecture of Vaadin applications
 description: Learn how to architect business applications with Vaadin.
+meta-description: Understand the architecture of Vaadin applications to design scalable and maintainable systems.
 order: 10
 ---
 
diff --git a/articles/building-apps/architecture/layers.adoc b/articles/building-apps/architecture/layers.adoc
@@ -1,6 +1,8 @@
 ---
 title: Conceptual Layers
+page-title: Implementing layered architecture in Vaadin applications
 description: Introduces the presentation layer and the application layer in Vaadin apps.
+meta-description: Learn about the layered architecture of Vaadin applications for modular design.
 order: 30
 ---
 

diff --git a/articles/building-apps/architecture/microservices.adoc b/articles/building-apps/architecture/microservices.adoc
@@ -1,6 +1,8 @@
 ---
 title: Microservices
+page-title: Microservices architecture in Vaadin
 description: How Vaadin fits into microservice-based systems.
+meta-description: Explore how to design and implement microservices architecture in Vaadin applications.
 order: 50
 ---
 

diff --git a/articles/building-apps/architecture/monoliths.adoc b/articles/building-apps/architecture/monoliths.adoc
@@ -1,6 +1,8 @@
 ---
 title: Monoliths
+page-title: How to design monolith architectures with Vaadin
 description: Essential concepts, as well as advantages and disadvantages of developing and using monolithic applications.
+meta-description: Explore best practices for building and managing monolithic applications with Vaadin.
 order: 40
 ---
 

diff --git a/articles/building-apps/index.adoc b/articles/building-apps/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Building Apps
+page-title: How to Build Apps with Vaadin
 description: How to build real-world business applications with Vaadin.
+meta-description: Get an overview of best practices and frameworks for building business applications with Vaadin.
 order: 800
 section-nav: flat expanded
 ---

diff --git a/articles/building-apps/project-structure/index.adoc b/articles/building-apps/project-structure/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Project Structure
+page-title: How to structure Vaadin projects
 description: The basics of structuring and packaging Vaadin projects.
+meta-description: Learn the basics of organizing your Vaadin application’s project structure.
 order: 20
 ---
 

diff --git a/articles/building-apps/project-structure/multi-module.adoc b/articles/building-apps/project-structure/multi-module.adoc
@@ -1,6 +1,8 @@
 ---
 title: Multi-module Projects
+page-title: How to organize Vaadin apps with a multi-module structure
 description: How and when to use multi-module projects for Vaadin applications.
+meta-description: Learn how to organize Vaadin applications with a multi-module project structure for scalability.
 order: 20
 ---
 

diff --git a/articles/building-apps/project-structure/single-module.adoc b/articles/building-apps/project-structure/single-module.adoc
@@ -1,6 +1,8 @@
 ---
 title: Single-module Projects
+page-title: How to structure single-module projects in Vaadin
 description: How and when to use single-module projects for Vaadin applications.
+meta-description: Learn how to structure single-module projects in Vaadin for simplicity and scalability.
 order: 10
 ---
 

diff --git a/articles/building-apps/spring-boot.adoc b/articles/building-apps/spring-boot.adoc
@@ -1,6 +1,8 @@
 ---
 title: Spring Boot
+page-title: Building Vaadin apps with Spring Boot: A comprehensive guide
 description: The role Spring Boot plays in Vaadin applications.
+meta-description: Learn how to build Vaadin applications with Spring Boot. Explore setup, integration, and best practices for developing modern web applications.
 order: 5
 ---
 

diff --git a/articles/compatibility.adoc b/articles/compatibility.adoc
@@ -1,6 +1,8 @@
 ---
 title: Supported Technologies
+page-title: Vaadin compatibility guide
 description: Lists the minimum required version of compatible technologies for Vaadin 24.
+meta-description: Learn about Vaadin’s compatibility with browsers, frameworks, and environments. See minimum required version of compatible technologies for Vaadin 24.
 order: 901
 ---
 

diff --git a/articles/components/accordion/index.adoc b/articles/components/accordion/index.adoc
@@ -1,6 +1,8 @@
 ---
 title: Accordion
+page-title: Accordion component | Vaadin components
 description: Accordion is a vertically stacked set of expandable panels.
+meta-description: The Vaadin component Accordion is a vertically stacked set of expandable panels you can leverage in your application's layout
 tab-title: Usage
 layout: tabbed-page
 page-links:

diff --git a/articles/components/accordion/styling.adoc b/articles/components/accordion/styling.adoc
@@ -1,6 +1,8 @@
 ---
 title: Styling
+page-title: How to style the Accordion component | Vaadin components
 description: Styling API reference for the Accordion component.
+meta-description: Explore options to customize the appearance of the Accordion component in your Vaadin apps.
 order: 50
 ---
 = Styling

diff --git a/articles/components/app-layout/index.adoc b/articles/components/app-layout/index.adoc
@@ -2,7 +2,9 @@
 tab-title: Usage
 layout: tabbed-page
 title: App Layout
+page-title: App Layout component | Vaadin components
 description: App Layout is a component for building common application layouts.
+meta-description: Create responsive application layouts with the App Layout component in Vaadin.
 page-links:
   - 'API: https://cdn.vaadin.com/vaadin-web-components/{moduleNpmVersion:@vaadin/app-layout}/#/elements/vaadin-app-layout[TypeScript] / https://vaadin.com/api/platform/{moduleMavenVersion:com.vaadin:vaadin}/com/vaadin/flow/component/applayout/AppLayout.html[Java]'
   - 'Source: https://github.com/vaadin/web-components/tree/v{moduleNpmVersion:@vaadin/app-layout}/packages/app-layout[TypeScript] / https://github.com/vaadin/flow-components/tree/{moduleMavenVersion:com.vaadin:vaadin}/vaadin-app-layout-flow-parent[Java]'

diff --git a/articles/components/app-layout/styling.adoc b/articles/components/app-layout/styling.adoc
@@ -1,6 +1,8 @@
 ---
 title: Styling
+page-title: How to style the App Layout component | Vaadin components
 description: Styling API reference for the App Layout component.
+meta-description: Customize the App Layout component in Vaadin to suit your application’s branding and style.
 order: 50
 ---
 = Styling

diff --git a/articles/components/auto-crud/index.adoc b/articles/components/auto-crud/index.adoc
@@ -1,7 +1,9 @@
 ---
 title: Auto CRUD
+page-title: Auto CRUD component | Vaadin components
 order: 10
 description: Used to populate automatically CRUD views and actions based on a Java backend service.
+meta-description: Learn how to use Vaadin Auto CRUD component to streamline CRUD operations in your applications. Explore features, configuration options, and implementation examples.
 section-nav: badge-hilla
 ---
 
@@ -23,17 +25,17 @@ Auto CRUD requires a Java service that implements the `CrudService<T, ID>` inter
 [.example]
 --
 [source,java]
-.EmployeeService.java
+.`EmployeeService.java`
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeService.java[tags=snippet,indent=0]
 ----
 [source,java]
-.Employee.java
+.`Employee.java`
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Employee.java[tags=snippet,indent=0]
 ----
 [source,java]
-.EmployeeRepository.java
+.`EmployeeRepository.java`
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeRepository.java[tags=snippet,indent=0]
 ----
@@ -147,22 +149,22 @@ The following example shows a basic implementation of a custom `CrudService` tha
 
 [.example]
 --
-.ProductDtoCrudService.java
+.`ProductDtoCrudService.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDtoCrudService.java[tags=snippet,indent=0]
 ----
-.ProductDto.java
+.`ProductDto.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDto.java[tags=snippet,indent=0]
 ----
-.Product.java
+.`Product.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
 ----
-.ProductRepository.java
+.`ProductRepository.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]

diff --git a/articles/components/auto-form/index.adoc b/articles/components/auto-form/index.adoc
@@ -1,7 +1,9 @@
 ---
 title: Auto Form
+page-title: Auto Form component | Vaadin components
 order: 15
 description: Auto Form is a component that renders a form for editing, updating and deleting items from a backend service.
+meta-description: Simplify form creation with the Auto Form component in your Vaadin applications.
 section-nav: badge-hilla
 ---
 
@@ -23,17 +25,17 @@ Auto Form requires a Java service that implements the `CrudService<T, ID>` inter
 [.example]
 --
 [source,java]
-.EmployeeService.java
+.`EmployeeService.java`
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeService.java[tags=snippet,indent=0]
 ----
 [source,java]
-.Employee.java
+.`Employee.java`
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Employee.java[tags=snippet,indent=0]
 ----
 [source,java]
-.EmployeeRepository.java
+.`EmployeeRepository.java`
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeRepository.java[tags=snippet,indent=0]
 ----
@@ -293,22 +295,22 @@ The following example shows a basic implementation of a custom `FormService` tha
 
 [.example]
 --
-.ProductDtoFormService.java
+.`ProductDtoFormService.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDtoFormService.java[tags=snippet,indent=0]
 ----
-.ProductDto.java
+.`ProductDto.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductDto.java[tags=snippet,indent=0]
 ----
-.Product.java
+.`Product.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/Product.java[tags=snippet,indent=0]
 ----
-.ProductRepository.java
+.`ProductRepository.java`
 [source,java]
 ----
 include::{root}/src/main/java/com/vaadin/demo/fusion/crud/ProductRepository.java[tags=snippet,indent=0]