Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add or enhance meta titles and descriptions #4019

Merged
merged 15 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/Docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/application-layer/index.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/architecture/components.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
3 changes: 2 additions & 1 deletion articles/building-apps/architecture/design.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/architecture/index.adoc
Original file line number Diff line number Diff line change
@@ -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
---

2 changes: 2 additions & 0 deletions articles/building-apps/architecture/layers.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/architecture/microservices.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/architecture/monoliths.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/index.adoc
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/project-structure/index.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/project-structure/multi-module.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/project-structure/single-module.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/building-apps/spring-boot.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/compatibility.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 2 additions & 0 deletions articles/components/accordion/index.adoc
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 2 additions & 0 deletions articles/components/accordion/styling.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions articles/components/app-layout/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]'
Expand Down
2 changes: 2 additions & 0 deletions articles/components/app-layout/styling.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
16 changes: 9 additions & 7 deletions articles/components/auto-crud/index.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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]
----
Expand Down Expand Up @@ -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]
Expand Down
16 changes: 9 additions & 7 deletions articles/components/auto-form/index.adoc
Original file line number Diff line number Diff line change
@@ -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
---

Expand All @@ -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]
----
Expand Down Expand Up @@ -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]
Expand Down
Loading
Loading