You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bifromq.apache.org by vi...@apache.org on 2026/08/13 02:31:13 UTC
(bifromq-sites) branch codex/site-metadata created (now d69cee21)
This is an automated email from the ASF dual-hosted git repository.
visoar pushed a change to branch codex/site-metadata
in repository https://gitbox.apache.org/repos/asf/bifromq-sites.git
at d69cee21 feat: improve site metadata and discovery
This branch includes the following new commits:
new d69cee21 feat: improve site metadata and discovery
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(bifromq-sites) 01/01: feat: improve site metadata and discovery
Posted by vi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
visoar pushed a commit to branch codex/site-metadata
in repository https://gitbox.apache.org/repos/asf/bifromq-sites.git
commit d69cee2165e6602b867f2ae50f9bee9be01e2ae5
Author: Visoar Zhang <vi...@gmail.com>
AuthorDate: Thu Aug 13 10:31:07 2026 +0800
feat: improve site metadata and discovery
---
blog/tags.yml | 39 ++++++++++++++
docs/get_started/quick_install.mdx | 2 +-
docs/user_guide/api/openapi.md | 1 +
docusaurus.config.ts | 8 ++-
src/pages/index.tsx | 51 ++++++++++++++++++-
src/pages/mqtt.mdx | 20 ++++----
src/theme/Blog/Pages/BlogAuthorsListPage/index.tsx | 31 ++++++++++++
src/theme/BlogListPage/index.tsx | 56 +++++++++++++++++++++
src/theme/BlogTagsListPage/index.tsx | 31 ++++++++++++
static/img/social-card.png | Bin 0 -> 56955 bytes
static/robots.txt | 4 ++
11 files changed, 229 insertions(+), 14 deletions(-)
diff --git a/blog/tags.yml b/blog/tags.yml
new file mode 100644
index 00000000..ff1791c4
--- /dev/null
+++ b/blog/tags.yml
@@ -0,0 +1,39 @@
+Apache:
+ label: Apache
+ permalink: /apache
+ description: Posts about Apache BifroMQ's development in the Apache Incubator.
+
+BifroMQ:
+ label: BifroMQ
+ permalink: /bifro-mq
+ description: Project news and technical articles about Apache BifroMQ.
+
+MQTT:
+ label: MQTT
+ permalink: /mqtt
+ description: Articles about MQTT protocol support, architecture, and operations.
+
+Multi-Tenant:
+ label: Multi-Tenant
+ permalink: /multi-tenant
+ description: Articles about multi-tenant MQTT workload and resource isolation.
+
+Serverless:
+ label: Serverless
+ permalink: /serverless
+ description: Articles about independently scalable MQTT service workloads.
+
+Decentralized Cluster:
+ label: Decentralized Cluster
+ permalink: /decentralized-cluster
+ description: Articles about Apache BifroMQ's distributed cluster architecture.
+
+Incubator:
+ label: Incubator
+ permalink: /incubator
+ description: News about Apache BifroMQ's progress in the Apache Incubator.
+
+Release:
+ label: Release
+ permalink: /release
+ description: Apache BifroMQ release announcements and related information.
diff --git a/docs/get_started/quick_install.mdx b/docs/get_started/quick_install.mdx
index adb4adf2..343bd869 100644
--- a/docs/get_started/quick_install.mdx
+++ b/docs/get_started/quick_install.mdx
@@ -17,7 +17,7 @@ For a rapid setup, Docker is recommended:
For further installation alternatives and comprehensive details, refer to [Installation](../installation/intro.md).
-# Quick Verify
+## Quick Verify
Below are the steps to quickly verify the basic MQTT functionality of BifroMQ using MQTTX.
diff --git a/docs/user_guide/api/openapi.md b/docs/user_guide/api/openapi.md
index c08db5c5..d41d0917 100644
--- a/docs/user_guide/api/openapi.md
+++ b/docs/user_guide/api/openapi.md
@@ -1,6 +1,7 @@
---
sidebar_position: 2
title: "OpenAPI Reference"
+hide_title: true
---
import ApiDocMdx from '@theme/ApiDocMdx';
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 20f74391..37d432fb 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -11,9 +11,9 @@ const mainRepoName = 'bifromq';
const siteRepoName = 'bifromq-sites';
const config: Config = {
- title: 'An Open Source Apache MQTT Broker | Apache BifroMQ (Incubating)',
+ title: 'Apache BifroMQ (Incubating)',
tagline:
- 'Java-based high-performance Apache MQTT Broker messaging middleware that adopts Multi-tenancy architecture.',
+ 'Open-source, distributed MQTT broker software with native multi-tenancy support.',
favicon: 'img/favicon.ico',
url: `https://${projectName.toLowerCase()}.apache.org/`,
baseUrl: '/',
@@ -122,6 +122,9 @@ const config: Config = {
},
},
blog: {
+ blogTitle: 'Apache BifroMQ Blog',
+ blogDescription:
+ 'Project news, releases, and technical articles from Apache BifroMQ (Incubating).',
showReadingTime: true,
blogSidebarCount: 10,
editUrl: () =>
@@ -146,6 +149,7 @@ const config: Config = {
],
themeConfig: {
+ image: 'img/social-card.png',
colorMode: {
defaultMode: 'light',
respectPrefersColorScheme: true,
diff --git a/src/pages/index.tsx b/src/pages/index.tsx
index 255ac037..f9ccc289 100644
--- a/src/pages/index.tsx
+++ b/src/pages/index.tsx
@@ -1,9 +1,51 @@
import React, { type ReactNode, useEffect } from 'react';
+import Head from '@docusaurus/Head';
import Link from '@docusaurus/Link';
import Layout from '@theme/Layout';
import { releaseVersion } from '../../releaseInfo';
import styles from './index.module.css';
+const homepageStructuredData = {
+ '@context': 'https://schema.org',
+ '@graph': [
+ {
+ '@type': 'WebSite',
+ '@id': 'https://bifromq.apache.org/#website',
+ url: 'https://bifromq.apache.org/',
+ name: 'Apache BifroMQ (Incubating)',
+ description:
+ 'Open-source, distributed MQTT broker software with native multi-tenancy support.',
+ inLanguage: 'en',
+ publisher: {
+ '@type': 'Organization',
+ name: 'The Apache Software Foundation',
+ url: 'https://www.apache.org/',
+ },
+ },
+ {
+ '@type': 'SoftwareApplication',
+ '@id': 'https://bifromq.apache.org/#software',
+ name: 'Apache BifroMQ',
+ url: 'https://bifromq.apache.org/',
+ applicationCategory: 'ServerApplication',
+ operatingSystem: 'Cross-platform',
+ softwareVersion: releaseVersion,
+ description:
+ 'Open-source, distributed MQTT broker software with native multi-tenancy support.',
+ license: 'https://www.apache.org/licenses/LICENSE-2.0',
+ codeRepository: 'https://github.com/apache/bifromq',
+ publisher: {
+ '@type': 'Organization',
+ name: 'The Apache Software Foundation',
+ url: 'https://www.apache.org/',
+ },
+ isPartOf: {
+ '@id': 'https://bifromq.apache.org/#website',
+ },
+ },
+ ],
+};
+
/**
* BifroMQ Landing Page - Bifrost Redesign
* Inspired by the Rainbow Bridge, emphasizing connectivity and architectural elegance.
@@ -29,8 +71,15 @@ export default function Home(): ReactNode {
return (
<Layout
- title="Apache BifroMQ | High-Performance Multi-tenant MQTT Broker"
+ title="Apache MQTT Broker"
description="Apache BifroMQ (Incubating) is open-source, distributed MQTT broker software with native multi-tenancy support.">
+ <Head
+ children={
+ <script type="application/ld+json">
+ {JSON.stringify(homepageStructuredData)}
+ </script>
+ }
+ />
<div className={styles.main}>
{/* --- HERO SECTION --- */}
diff --git a/src/pages/mqtt.mdx b/src/pages/mqtt.mdx
index 3f2dde4f..72b7cb59 100644
--- a/src/pages/mqtt.mdx
+++ b/src/pages/mqtt.mdx
@@ -1,6 +1,6 @@
---
-title: MQTT Protocol Guide | Apache BifroMQ
-description: Learn what MQTT is, how publish/subscribe messaging works, and how Apache BifroMQ implements MQTT for large-scale, multi-tenant IoT messaging.
+title: MQTT Protocol Guide
+description: Learn how MQTT publish/subscribe messaging works and how Apache BifroMQ (Incubating) implements an MQTT broker for multi-tenant IoT messaging.
keywords:
- MQTT
- MQTT protocol
@@ -20,19 +20,19 @@ import { releaseVersion } from '../../releaseInfo';
{JSON.stringify({
'@context': 'https://schema.org',
'@type': 'TechArticle',
- headline: 'MQTT Protocol Guide for Apache BifroMQ',
+ headline: 'MQTT Protocol Guide for Apache BifroMQ (Incubating)',
description:
- 'Learn what MQTT is, how publish/subscribe messaging works, and how Apache BifroMQ implements MQTT for large-scale, multi-tenant IoT messaging.',
+ 'Learn how MQTT publish/subscribe messaging works and how Apache BifroMQ (Incubating) implements an MQTT broker for multi-tenant IoT messaging.',
url: 'https://bifromq.apache.org/mqtt/',
author: {
'@type': 'Organization',
- name: 'Apache BifroMQ',
- url: 'https://bifromq.apache.org/',
+ name: 'The Apache Software Foundation',
+ url: 'https://www.apache.org/',
},
publisher: {
'@type': 'Organization',
- name: 'Apache BifroMQ',
- url: 'https://bifromq.apache.org/',
+ name: 'The Apache Software Foundation',
+ url: 'https://www.apache.org/',
},
mainEntity: [
{
@@ -58,9 +58,9 @@ import { releaseVersion } from '../../releaseInfo';
</script>
</Head>
-# MQTT Protocol Guide for Apache BifroMQ
+# MQTT Protocol Guide for Apache BifroMQ (Incubating)
-MQTT is a lightweight publish/subscribe messaging protocol widely used for IoT, telemetry, and real-time messaging. This guide explains how MQTT works, why a broker sits at the center of every deployment, and how [Apache BifroMQ](/docs/get_started/intro/) delivers a production‑grade Apache MQTT broker implementation for large‑scale, multi‑tenant device connectivity.
+MQTT is a lightweight publish/subscribe messaging protocol widely used for IoT, telemetry, and real-time messaging. This guide explains how MQTT works, why a broker sits at the center of every deployment, and how [Apache BifroMQ (Incubating)](/docs/get_started/intro/) provides open-source Apache MQTT broker software for multi-tenant device connectivity.
For the official protocol documents, see the [MQTT Specification](https://mqtt.org/mqtt-specification/) page on MQTT.org.
diff --git a/src/theme/Blog/Pages/BlogAuthorsListPage/index.tsx b/src/theme/Blog/Pages/BlogAuthorsListPage/index.tsx
new file mode 100644
index 00000000..db780b8f
--- /dev/null
+++ b/src/theme/Blog/Pages/BlogAuthorsListPage/index.tsx
@@ -0,0 +1,31 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0.
+ */
+
+import React, { type ReactNode } from 'react';
+import Head from '@docusaurus/Head';
+import OriginalBlogAuthorsListPage from '@theme-original/Blog/Pages/BlogAuthorsListPage';
+import type { Props } from '@theme/Blog/Pages/BlogAuthorsListPage';
+
+const description =
+ 'Authors contributing project news and technical articles to the Apache BifroMQ blog.';
+
+export default function BlogAuthorsListPage(props: Props): ReactNode {
+ return (
+ <>
+ <Head
+ children={
+ <>
+ <meta name="description" content={description} />
+ <meta property="og:description" content={description} />
+ </>
+ }
+ />
+ <OriginalBlogAuthorsListPage {...props} />
+ </>
+ );
+}
diff --git a/src/theme/BlogListPage/index.tsx b/src/theme/BlogListPage/index.tsx
new file mode 100644
index 00000000..a4b51a0d
--- /dev/null
+++ b/src/theme/BlogListPage/index.tsx
@@ -0,0 +1,56 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0.
+ */
+
+import React, { type ReactNode } from 'react';
+import clsx from 'clsx';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import {
+ HtmlClassNameProvider,
+ PageMetadata,
+ ThemeClassNames,
+} from '@docusaurus/theme-common';
+import BlogLayout from '@theme/BlogLayout';
+import BlogListPageStructuredData from '@theme/BlogListPage/StructuredData';
+import BlogListPaginator from '@theme/BlogListPaginator';
+import BlogPostItems from '@theme/BlogPostItems';
+import Heading from '@theme/Heading';
+import SearchMetadata from '@theme/SearchMetadata';
+import type { Props } from '@theme/BlogListPage';
+
+export default function BlogListPage(props: Props): ReactNode {
+ const { metadata, items, sidebar } = props;
+ const {
+ siteConfig: { title: siteTitle },
+ } = useDocusaurusContext();
+ const { blogDescription, blogTitle, permalink } = metadata;
+ const pageTitle = permalink === '/' ? siteTitle : blogTitle;
+
+ return (
+ <HtmlClassNameProvider
+ className={clsx(
+ ThemeClassNames.wrapper.blogPages,
+ ThemeClassNames.page.blogListPage,
+ )}
+ children={
+ <>
+ <PageMetadata title={pageTitle} description={blogDescription} />
+ <SearchMetadata tag="blog_posts_list" />
+ <BlogListPageStructuredData {...props} />
+ <BlogLayout sidebar={sidebar}>
+ <header className="margin-bottom--xl">
+ <Heading as="h1">{blogTitle}</Heading>
+ <p>{blogDescription}</p>
+ </header>
+ <BlogPostItems items={items} />
+ <BlogListPaginator metadata={metadata} />
+ </BlogLayout>
+ </>
+ }
+ />
+ );
+}
diff --git a/src/theme/BlogTagsListPage/index.tsx b/src/theme/BlogTagsListPage/index.tsx
new file mode 100644
index 00000000..fa82fc38
--- /dev/null
+++ b/src/theme/BlogTagsListPage/index.tsx
@@ -0,0 +1,31 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0.
+ */
+
+import React, { type ReactNode } from 'react';
+import Head from '@docusaurus/Head';
+import OriginalBlogTagsListPage from '@theme-original/BlogTagsListPage';
+import type { Props } from '@theme/BlogTagsListPage';
+
+const description =
+ 'Browse Apache BifroMQ blog posts by project and technical topic.';
+
+export default function BlogTagsListPage(props: Props): ReactNode {
+ return (
+ <>
+ <Head
+ children={
+ <>
+ <meta name="description" content={description} />
+ <meta property="og:description" content={description} />
+ </>
+ }
+ />
+ <OriginalBlogTagsListPage {...props} />
+ </>
+ );
+}
diff --git a/static/img/social-card.png b/static/img/social-card.png
new file mode 100644
index 00000000..8504a538
Binary files /dev/null and b/static/img/social-card.png differ
diff --git a/static/robots.txt b/static/robots.txt
new file mode 100644
index 00000000..f7be8ff2
--- /dev/null
+++ b/static/robots.txt
@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://bifromq.apache.org/sitemap.xml