Add description to each page (expressjs#1639) (expressjs#1672)

* Add description to each page (expressjs#1639) * fix: rersolved description issues and also added the descriptions in the es folder * feat: added descriptions in all the languages
chrisdel101 · Nov 3, 2024 · 79a2f9d · 79a2f9d
1 parent 966e43b
commit 79a2f9d
Show file tree

Hide file tree

Showing 495 changed files with 992 additions and 13 deletions.
diff --git a/_posts/2024-07-16-welcome-post.md b/_posts/2024-07-16-welcome-post.md
@@ -1,5 +1,6 @@
 ---
-title: Welcome to The Express Blog! 
+title: Welcome to The Express Blog!
+description: Introducing the new Express blog — a primary platform for announcements, updates, and communication from the Express technical committee.
 tags: site-admin
 author: Rand McKinney and Chris Del
 ---

diff --git a/de/3x/api.md b/de/3x/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 3x-api
 title: Express 3.x - API-Referenz
+description: Access the API reference for Express.js version 3.x, noting that this version is end-of-life and no longer maintained - includes details on modules and methods.
 menu: api
 lang: de
 ---

diff --git a/de/4x/api.md b/de/4x/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 4x-api
 title: Express 4.x - API-Referenz
+description: Access the API reference for Express.js 4.x, detailing all modules, methods, and properties for building web applications with this version.
 menu: api
 lang: de
 ---

diff --git a/de/5x/api.md b/de/5x/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 5x-api
 title: Express 5.x - API-Referenz
+description: Access the API reference for Express.js 5.x, detailing all modules, methods, and properties for building web applications with this latest version.
 menu: api
 lang: de
 ---

diff --git a/de/advanced/best-practice-performance.md b/de/advanced/best-practice-performance.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Leistungsspezifische Best Practices für Express-Anwendungen in Produktionsumgebungen
+description: Discover performance and reliability best practices for Express apps in production, covering code optimizations and environment setups for optimal performance.
 menu: advanced
 lang: de
 ---

diff --git a/de/advanced/best-practice-security.md b/de/advanced/best-practice-security.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Sicherheitsspezifische Best Practices für Express-Anwendungen in Produktionsumgebungen
+description: Discover crucial security best practices for Express apps in production, including using TLS, input validation, secure cookies, and preventing vulnerabilities.
 menu: advanced
 lang: de
 ---

diff --git a/de/advanced/developing-template-engines.md b/de/advanced/developing-template-engines.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Template-Engines für Express entwickeln
+description: Learn how to develop custom template engines for Express.js using app.engine(), with examples on creating and integrating your own template rendering logic.
 menu: advanced
 lang: de
 ---

diff --git a/de/advanced/security-updates.md b/de/advanced/security-updates.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express-Sicherheitsupdates
+description: Review the latest security updates and patches for Express.js, including detailed vulnerability lists for different versions to help maintain a secure application.
 menu: advanced
 lang: de
 ---

diff --git a/de/api.md b/de/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 4x-api
 title: Express 4.x - API-Referenz
+description: Access the API reference for Express.js detailing all modules, methods, and properties for building web applications with this version.
 lang: de
 ---
 <div id="api-doc" markdown="1">

diff --git a/de/guide/behind-proxies.md b/de/guide/behind-proxies.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express hinter Proxys
+description: Learn how to configure Express.js applications to work correctly behind reverse proxies, including using the trust proxy setting to handle client IP addresses.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/database-integration.md b/de/guide/database-integration.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Datenbankintegration in Express
+description: Discover how to integrate various databases with Express.js applications, including setup examples for MongoDB, MySQL, PostgreSQL, and more.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/debugging.md b/de/guide/debugging.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Debugging bei Express
+description: Learn how to enable and use debugging logs in Express.js applications by setting the DEBUG environment variable for enhanced troubleshooting.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/error-handling.md b/de/guide/error-handling.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Fehlerbehandlung in Express
+description: Understand how Express.js handles errors in synchronous and asynchronous code, and learn to implement custom error handling middleware for your applications.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/migrating-4.md b/de/guide/migrating-4.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Migration auf Express 4
+description: A guide to migrating your Express.js applications from version 3 to 4, covering changes in middleware, routing, and how to update your codebase effectively.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/migrating-5.md b/de/guide/migrating-5.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Migration auf Express 5
+description: A comprehensive guide to migrating your Express.js applications from version 4 to 5, detailing breaking changes, deprecated methods, and new improvements.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/routing.md b/de/guide/routing.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Weiterleitung in Express
+description: Learn how to define and use routes in Express.js applications, including route methods, route paths, parameters, and using Router for modular routing.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/using-middleware.md b/de/guide/using-middleware.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express-Middleware verwenden
+description: Learn how to use middleware in Express.js applications, including application-level and router-level middleware, error handling, and integrating third-party middleware.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/using-template-engines.md b/de/guide/using-template-engines.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Template-Engines in Express verwenden
+description: Discover how to integrate and use template engines like Pug, Handlebars, and EJS with Express.js to render dynamic HTML pages efficiently.
 menu: guide
 lang: de
 ---

diff --git a/de/guide/writing-middleware.md b/de/guide/writing-middleware.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Middleware für die Verwendung in Express-Anwendungen schreiben
+description: Learn how to write custom middleware functions for Express.js applications, including examples and best practices for enhancing request and response handling.
 menu: guide
 lang: de
 ---

diff --git a/de/index.md b/de/index.md
@@ -1,6 +1,7 @@
 ---
 layout: home
 title: Express - Node.js-Framework von Webanwendungen
+description: "Express is a fast, unopinionated, minimalist web framework for Node.js, providing a robust set of features for web and mobile applications."
 menu: home
 lang: de
 ---

diff --git a/de/resources/community.md b/de/resources/community.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express-Community
+description: Connect with the Express.js community, learn about the technical committee, find resources, explore community-contributed modules, and get involved in discussions.
 menu: resources
 lang: de
 ---

diff --git a/de/resources/glossary.md b/de/resources/glossary.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express-Glossar
+description: A comprehensive glossary of terms related to Express.js, Node.js, middleware, routing, and other key concepts to help you understand and use Express effectively.
 menu: resources
 lang: de
 ---

diff --git a/de/resources/middleware.md b/de/resources/middleware.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express-Middleware
+description: Explore a list of Express.js middleware modules maintained by the Express team and the community, including built-in middleware and popular third-party modules.
 menu: resources
 lang: de
 ---

diff --git a/de/starter/basic-routing.md b/de/starter/basic-routing.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Basisrouting in Express
+description: Learn the fundamentals of routing in Express.js applications, including how to define routes, handle HTTP methods, and create route handlers for your web server.
 menu: starter
 lang: de
 ---

diff --git a/de/starter/faq.md b/de/starter/faq.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Häufig gestellte Fragen zu Express
+description: Find answers to frequently asked questions about Express.js, including topics on application structure, models, authentication, template engines, error handling, and more.
 menu: starter
 lang: de
 ---

diff --git a/de/starter/generator.md b/de/starter/generator.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express-Anwendungsgenerator
+description: Learn how to use the Express application generator tool to quickly create a skeleton for your Express.js applications, streamlining setup and configuration.
 menu: starter
 lang: de
 ---

diff --git a/de/starter/hello-world.md b/de/starter/hello-world.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Beispiel "Hello World" in Express
+description: Get started with Express.js by building a simple 'Hello World' application, demonstrating the basic setup and server creation for beginners.
 menu: starter
 lang: de
 ---

diff --git a/de/starter/installing.md b/de/starter/installing.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express installieren
+description: Learn how to install Express.js in your Node.js environment, including setting up your project directory and managing dependencies with npm.
 menu: starter
 lang: de
 ---

diff --git a/de/starter/static-files.md b/de/starter/static-files.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Statische Dateien in Express bereitstellen
+description: Understand how to serve static files like images, CSS, and JavaScript in Express.js applications using the built-in 'static' middleware.
 menu: starter
 lang: de
 ---

diff --git a/en/3x/api.md b/en/3x/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 3x-api
 title: Express 3.x - API Reference
+description: Access the API reference for Express.js version 3.x, noting that this version is end-of-life and no longer maintained - includes details on modules and methods.
 menu: api
 lang: en
 redirect_from: "/3x/api.html"

diff --git a/en/4x/api.md b/en/4x/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 4x-api
 title: Express 4.x - API Reference
+description: Access the API reference for Express.js 4.x, detailing all modules, methods, and properties for building web applications with this version.
 menu: api
 lang: en
 redirect_from: "/4x/api.html"

diff --git a/en/5x/api.md b/en/5x/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 5x-api
 title: Express 5.x - API Reference
+description: Access the API reference for Express.js 5.x, detailing all modules, methods, and properties for building web applications with this latest version.
 menu: api
 lang: en
 redirect_from: "/5x/api.html"

diff --git a/en/advanced/best-practice-performance.md b/en/advanced/best-practice-performance.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Performance Best Practices Using Express in Production
+description: Discover performance and reliability best practices for Express apps in production, covering code optimizations and environment setups for optimal performance.
 menu: advanced
 lang: en
 redirect_from: "/advanced/best-practice-performance.html"

diff --git a/en/advanced/best-practice-security.md b/en/advanced/best-practice-security.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Security Best Practices for Express in Production
+description: Discover crucial security best practices for Express apps in production, including using TLS, input validation, secure cookies, and preventing vulnerabilities.
 menu: advanced
 lang: en
 redirect_from: "/advanced/best-practice-security.html"

diff --git a/en/advanced/developing-template-engines.md b/en/advanced/developing-template-engines.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Developing template engines for Express
+description: Learn how to develop custom template engines for Express.js using app.engine(), with examples on creating and integrating your own template rendering logic.
 menu: advanced
 lang: en
 redirect_from: "/advanced/developing-template-engines.html"

diff --git a/en/advanced/healthcheck-graceful-shutdown.md b/en/advanced/healthcheck-graceful-shutdown.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Health Checks and Graceful Shutdown
+description: Learn how to implement health checks and graceful shutdown in Express apps to enhance reliability, manage deployments, and integrate with load balancers like Kubernetes.
 menu: advanced
 lang: en
 redirect_from: "/advanced/healthcheck-graceful-shutdown.html"

diff --git a/en/advanced/security-updates.md b/en/advanced/security-updates.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express security updates
+description: Review the latest security updates and patches for Express.js, including detailed vulnerability lists for different versions to help maintain a secure application.
 menu: advanced
 lang: en
 redirect_from: "/advanced/security-updates.html"

diff --git a/en/api.md b/en/api.md
@@ -1,6 +1,7 @@
 ---
 layout: 4x-api
 title: Express 4.x - API Reference
+description: Access the API reference for Express.js detailing all modules, methods, and properties for building web applications with this version.
 lang: en
 redirect_from: "/api.html"
 ---

diff --git a/en/blog/posts.md b/en/blog/posts.md
@@ -1,6 +1,7 @@
 ---
 layout: post
 title: Express Blog Posts
+description: Explore the latest articles, announcements, and updates from the Express.js team and community on the Express blog.
 menu: blog
 lang: en
 redirect_from: "/blog/posts.html"

diff --git a/en/blog/write-post.md b/en/blog/write-post.md
@@ -1,6 +1,7 @@
 ---
 layout: post
 title: How to write a blog post
+description: Learn how to propose and write a blog post for the Express.js blog, including submission guidelines and steps to contribute your content.
 menu: blog
 lang: en
 redirect_from: "/blog/write.html"

diff --git a/en/changelog/4x.md b/en/changelog/4x.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express 4.x changelog
+description: Stay updated with the release change log for Express.js 4.x, detailing new features, bug fixes, and important changes across versions.
 menu: changelog
 lang: en
 redirect_from: "/changelog/4x.html"

diff --git a/en/guide/behind-proxies.md b/en/guide/behind-proxies.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express behind proxies
+description: Learn how to configure Express.js applications to work correctly behind reverse proxies, including using the trust proxy setting to handle client IP addresses.
 menu: guide
 lang: en
 redirect_from: "/guide/behind-proxies.html"

diff --git a/en/guide/database-integration.md b/en/guide/database-integration.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express database integration
+description: Discover how to integrate various databases with Express.js applications, including setup examples for MongoDB, MySQL, PostgreSQL, and more.
 menu: guide
 lang: en
 redirect_from: "/guide/database-integration.html"

diff --git a/en/guide/debugging.md b/en/guide/debugging.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Debugging Express
+description: Learn how to enable and use debugging logs in Express.js applications by setting the DEBUG environment variable for enhanced troubleshooting.
 menu: guide
 lang: en
 redirect_from: "/guide/debugging.html"

diff --git a/en/guide/error-handling.md b/en/guide/error-handling.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express error handling
+description: Understand how Express.js handles errors in synchronous and asynchronous code, and learn to implement custom error handling middleware for your applications.
 menu: guide
 lang: en
 redirect_from: "/guide/error-handling.html"

diff --git a/en/guide/migrating-4.md b/en/guide/migrating-4.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Migrating to Express 4
+description: A guide to migrating your Express.js applications from version 3 to 4, covering changes in middleware, routing, and how to update your codebase effectively.
 menu: guide
 lang: en
 redirect_from: "/guide/migrating-4.html"

diff --git a/en/guide/migrating-5.md b/en/guide/migrating-5.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Migrating to Express 5
+description: A comprehensive guide to migrating your Express.js applications from version 4 to 5, detailing breaking changes, deprecated methods, and new improvements.
 menu: guide
 lang: en
 redirect_from: "/guide/migrating-5.html"

diff --git a/en/guide/overriding-express-api.md b/en/guide/overriding-express-api.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Overriding the Express API
+description: Discover how to customize and extend the Express.js API by overriding methods and properties on the request and response objects using prototypes.
 menu: guide
 lang: en
 ---

diff --git a/en/guide/routing.md b/en/guide/routing.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Express routing
+description: Learn how to define and use routes in Express.js applications, including route methods, route paths, parameters, and using Router for modular routing.
 menu: guide
 lang: en
 redirect_from: "/guide/routing.html"

diff --git a/en/guide/using-middleware.md b/en/guide/using-middleware.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Using Express middleware
+description: Learn how to use middleware in Express.js applications, including application-level and router-level middleware, error handling, and integrating third-party middleware.
 menu: guide
 lang: en
 redirect_from: "/guide/using-middleware.html"