mirror of
https://github.com/cloudnative-pg/plugin-barman-cloud.git
synced 2026-01-11 21:23:12 +01:00
Rework the documentation to be a static website instead of just the GitHub README.md. Use docusaurus to create the website, and the CI to publish to GitHub pages on commits to main. Block `release-please` releases unless the documentation for that version has been generated. Closes #244 Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com> Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com> Co-authored-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com> Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
153 lines
4.4 KiB
TypeScript
153 lines
4.4 KiB
TypeScript
import {themes as prismThemes} from 'prism-react-renderer';
|
|
import type {Config} from '@docusaurus/types';
|
|
import type * as Preset from '@docusaurus/preset-classic';
|
|
|
|
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
|
|
|
const config: Config = {
|
|
title: 'Barman Cloud CNPG-I plugin',
|
|
favicon: 'img/favicon.ico',
|
|
|
|
// Set the production url of your site here
|
|
url: 'https://cloudnative-pg.github.io',
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: '/plugin-barman-cloud/',
|
|
trailingSlash: true,
|
|
|
|
// GitHub pages deployment config.
|
|
organizationName: 'cloudnative-pg',
|
|
projectName: 'plugin-barman-cloud',
|
|
deploymentBranch: 'gh-pages',
|
|
|
|
onBrokenLinks: 'throw',
|
|
onBrokenMarkdownLinks: 'throw',
|
|
|
|
// Even if you don't use internationalization, you can use this field to set
|
|
// useful metadata like html lang. For example, if your site is Chinese, you
|
|
// may want to replace "en" with "zh-Hans".
|
|
i18n: {
|
|
defaultLocale: 'en',
|
|
locales: ['en'],
|
|
},
|
|
|
|
presets: [
|
|
[
|
|
'classic',
|
|
{
|
|
docs: {
|
|
path: 'docs',
|
|
sidebarPath: './sidebars.ts',
|
|
includeCurrentVersion: true, // Include the current version in the sidebar
|
|
versions:{
|
|
current:{
|
|
label: 'Dev',
|
|
badge: true,
|
|
banner: "unreleased",
|
|
},
|
|
}
|
|
},
|
|
theme: {
|
|
customCss: './src/css/custom.css',
|
|
},
|
|
} satisfies Preset.Options,
|
|
],
|
|
],
|
|
themes: [
|
|
[
|
|
require.resolve("@easyops-cn/docusaurus-search-local"),
|
|
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
|
|
({
|
|
hashed: true,
|
|
docsDir: ['docs'],
|
|
searchResultLimits: 8,
|
|
searchResultContextMaxLength: 50,
|
|
language: ["en"],
|
|
// Only index headings and content
|
|
indexBlog: false,
|
|
indexPages: false,
|
|
}),
|
|
],
|
|
],
|
|
themeConfig: {
|
|
image: 'img/cloudnativepg-social-card.png',
|
|
navbar: {
|
|
title: 'Barman Cloud CNPG-I plugin',
|
|
logo: {
|
|
alt: 'CloudNativePG Logo',
|
|
src: 'img/logo.svg',
|
|
},
|
|
items: [
|
|
{
|
|
type: 'docSidebar',
|
|
sidebarId: 'docs',
|
|
position: 'left',
|
|
label: 'Documentation',
|
|
},
|
|
{
|
|
type: 'docsVersionDropdown',
|
|
position: 'right',
|
|
},
|
|
{
|
|
href: "https://github.com/cloudnative-pg/plugin-barman-cloud",
|
|
position: "right",
|
|
className: "header-github-link",
|
|
"aria-label": "GitHub repository",
|
|
},
|
|
|
|
],
|
|
},
|
|
footer: {
|
|
logo: {
|
|
alt: 'CloudNativePG Logo',
|
|
src: "img/cloudnativepg-landscape-white.png",
|
|
href: "https://cloudnative-pg.io",
|
|
},
|
|
style: 'dark',
|
|
links: [
|
|
{
|
|
title: 'Community',
|
|
items: [
|
|
{
|
|
label: 'Slack',
|
|
href: 'https://cloud-native.slack.com/messages/cloudnativepg-users',
|
|
},
|
|
{
|
|
label: 'X',
|
|
href: 'https://x.com/CloudNativePG',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'More',
|
|
items: [
|
|
{
|
|
label: 'GitHub',
|
|
href: 'https://github.com/cloudnative-pg/plugin-barman-cloud',
|
|
},
|
|
{
|
|
label: 'CloudNativePG',
|
|
href: 'https://cloudnative-pg.io',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `
|
|
Copyright © ${new Date().getFullYear()} CloudNativePG a Series of LF Projects, LLC.<br><br>
|
|
|
|
For website terms of use, trademark policy and other project policies please see
|
|
<a href="https://lfprojects.org/policies/">LF Projects, LLC Policies</a>.<br>
|
|
<a href="https://www.linuxfoundation.org/trademark-usage/">The Linux Foundation has registered trademarks and uses trademarks</a>.<br>
|
|
<a href="https://www.postgresql.org/about/policies/trademarks">Postgres, PostgreSQL and the Slonik Logo are
|
|
trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and
|
|
used with their permission</a>.`
|
|
},
|
|
prism: {
|
|
theme: prismThemes.github,
|
|
darkTheme: prismThemes.dracula,
|
|
},
|
|
} satisfies Preset.ThemeConfig,
|
|
};
|
|
|
|
export default config;
|