open_graph

bencherdev · Oct 6, 2023 · b23aa11 · b23aa11
1 parent bd59551
commit b23aa11
Show file tree

Hide file tree

Showing 48 changed files with 244 additions and 112 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -16,6 +16,9 @@
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "rust-lang.rust-analyzer"
   },
+  "[astro]": {
+    "editor.formatOnSave": false,
+  },
   "[javascript]": {
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "rome.rome"

diff --git a/services/console/astro.config.mjs b/services/console/astro.config.mjs
@@ -13,7 +13,9 @@ export default defineConfig({
 	output: "hybrid",
 	integrations: [
 		// https://docs.astro.build/en/guides/integrations-guide/sitemap
-		sitemap(),
+		sitemap({
+			filter: sitemapFilter,
+		}),
 		// https://docs.astro.build/en/guides/integrations-guide/mdx
 		mdx(),
 		// https://docs.astro.build/en/guides/integrations-guide/partytown
@@ -34,3 +36,12 @@ export default defineConfig({
 		remarkPlugins: [remarkGfm],
 	},
 });
+
+// https://docs.astro.build/en/guides/integrations-guide/sitemap/#filter
+const sitemapFilter = (page) =>
+	!(
+		page.includes("bencher.dev/console") ||
+		page.includes("bencher.dev/chat") ||
+		page.includes("bencher.dev/demo") ||
+		page.includes("bencher.dev/repo")
+	);
diff --git a/services/console/public/robots.txt b/services/console/public/robots.txt
@@ -1,5 +1,8 @@
 User-agent: *
 Disallow: /console$
 Disallow: /console/
+Disallow: /chat$
 Disallow: /demo$
 Disallow: /repo$
+
+Sitemap: https://bencher.dev/sitemap-index.xml
diff --git a/services/console/src/components/console/perf/plot/PlotHeader.tsx b/services/console/src/components/console/perf/plot/PlotHeader.tsx
@@ -164,11 +164,11 @@ const PlotHeader = (props: Props) => {
 										class="icon-text"
 										data-tooltip="Display lower/upper Metric values"
 									>
-										<span>⠀Value</span>
+										<span style="padding-left: 1em">Value</span>
 										<span class="icon">
 											<i class="fas fa-info-circle" aria-hidden="true" />
 										</span>
-										<span>⠀</span>
+										<span style="padding-right: 1em"></span>
 									</div>
 									<div class="columns">
 										<div class="column">
@@ -236,11 +236,11 @@ const PlotHeader = (props: Props) => {
 											class="icon-text"
 											data-tooltip="Toggle X-Axis between Date and Branch Version"
 										>
-											<span>⠀X-Axis</span>
+											<span style="padding-left: 0.5em">X-Axis</span>
 											<span class="icon">
 												<i class="fas fa-info-circle" aria-hidden="true" />
 											</span>
-											<span>⠀</span>
+											<span style="padding-right: 0.5em"></span>
 										</div>
 										<div class="columns">
 											<div class="column">
@@ -319,7 +319,7 @@ const PlotHeader = (props: Props) => {
 					<div class="level-item">
 						<div class="columns">
 							<div class="column">
-								<p>⠀Clear⠀</p>
+								<p style="padding-left: 1em;padding-right: 1em;">Clear</p>
 								<div class="columns">
 									<div class="column">
 										<button

diff --git a/services/console/src/components/site/Footer.tsx b/services/console/src/components/site/Footer.tsx
@@ -3,31 +3,58 @@ import { BENCHER_GITHUB_URL, BENCHER_CHAT_URL } from "../../util/ext";
 const Footer = () => (
 	<footer class="footer" style="margin-top:1rem;">
 		<div class="container">
-			<div class="content">
-				<nav class="level">
-					<div class="level-left">
-						<div class="level-item has-text-centered">
-							<p>
-								<a href="/legal/terms-of-use">Terms of Use</a>
-							</p>
-						</div>
-						<div class="level-item has-text-centered">
-							<p>
-								<a href="/legal/privacy">Privacy Policy</a>
-							</p>
-						</div>
-						<div class="level-item has-text-centered">
-							<p>
-								<a href="/legal/license">License Agreement</a>
-							</p>
-						</div>
-					</div>
-				</nav>
-			</div>
-			<div class="columns is-mobile">
+			<div class="columns is-vcentered is-mobile">
 				<div class="column">
 					<div class="content">
-						<p>Bencher - Continuous Benchmarking</p>
+						<h4 class="title">🐰 Bencher - Continuous Benchmarking</h4>
+						<nav class="level">
+							<div class="level-left">
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/docs">Docs</a>
+									</p>
+								</div>
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/pricing">Pricing</a>
+									</p>
+								</div>
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/help">Help</a>
+									</p>
+								</div>
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/legal">Legal</a>
+									</p>
+								</div>
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/sitemap-index.xml">Sitemap</a>
+									</p>
+								</div>
+							</div>
+						</nav>
+						<nav class="level">
+							<div class="level-left">
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/legal/terms-of-use">Terms of Use</a>
+									</p>
+								</div>
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/legal/privacy">Privacy Policy</a>
+									</p>
+								</div>
+								<div class="level-item has-text-centered">
+									<p>
+										<a href="/legal/license">License Agreement</a>
+									</p>
+								</div>
+							</div>
+						</nav>
 					</div>
 				</div>
 				<div class="column is-narrow">

diff --git a/services/console/src/content/config.ts b/services/console/src/content/config.ts
@@ -6,6 +6,7 @@ const legal = defineCollection({
 	type: "content", // v2.5.0 and later
 	schema: z.object({
 		title: z.string(),
+		description: z.string(),
 		heading: z.string(),
 		sortOrder: z.number(),
 	}),
@@ -14,6 +15,7 @@ const tutorial = defineCollection({
 	type: "content", // v2.5.0 and later
 	schema: z.object({
 		title: z.string(),
+		description: z.string(),
 		heading: z.string(),
 		sortOrder: z.number(),
 	}),
@@ -22,6 +24,7 @@ const how_to = defineCollection({
 	type: "content", // v2.5.0 and later
 	schema: z.object({
 		title: z.string(),
+		description: z.string(),
 		heading: z.string(),
 		sortOrder: z.number(),
 	}),
@@ -30,6 +33,7 @@ const explanation = defineCollection({
 	type: "content", // v2.5.0 and later
 	schema: z.object({
 		title: z.string(),
+		description: z.string(),
 		heading: z.string(),
 		sortOrder: z.number(),
 	}),
@@ -38,6 +42,7 @@ const reference = defineCollection({
 	type: "content", // v2.5.0 and later
 	schema: z.object({
 		title: z.string(),
+		description: z.string(),
 		heading: z.string(),
 		sortOrder: z.number(),
 	}),

diff --git a/services/console/src/content/explanation/adapters.mdx b/services/console/src/content/explanation/adapters.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Benchmark Adapters"
+description: "Use your favorite code benchmark harness with Bencher's built in adapters or use a custom code benchmark harness that outputs JSON"
 heading: "Benchmark Harness Adapters"
 sortOrder: 3
 ---

diff --git a/services/console/src/content/explanation/bencher-run.mdx b/services/console/src/content/explanation/bencher-run.mdx
@@ -1,5 +1,6 @@
 ---
 title: "bencher run"
+description: "Overview of the bencher run CLI subcommand and all of its flags, arguments, and features"
 heading: "bencher run CLI Subcommand"
 sortOrder: 2
 ---

diff --git a/services/console/src/content/explanation/benchmarking.mdx b/services/console/src/content/explanation/benchmarking.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Benchmarking Overview"
+description: "The conceptual model and vocabulary used by Bencher to track the results of code benchmarks"
 heading: "Benchmarking Overview"
 sortOrder: 1
 ---

diff --git a/services/console/src/content/explanation/branch-selection.mdx b/services/console/src/content/explanation/branch-selection.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Branch Selection"
+description: "Overview of the ways to select a git branch using the bencher run CLI subcommand"
 heading: "Branch Selection with bencher run"
 sortOrder: 3
 ---

diff --git a/services/console/src/content/explanation/continuous-benchmarking.mdx b/services/console/src/content/explanation/continuous-benchmarking.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Continuous Benchmarking"
+description: "Continuous Benchmarking is a software development practice where members of a team benchmark their code frequently and catch performance regressions in CI"
 heading: "What is Continuous Benchmarking?"
 sortOrder: 5
 ---

diff --git a/services/console/src/content/explanation/talks.mdx b/services/console/src/content/explanation/talks.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Bencher Talks"
+description: "Talks about Bencher and Continuous Benchmarking by Everett Pompeii"
 heading: "Bencher Talks"
 sortOrder: 6
 ---

diff --git a/services/console/src/content/explanation/thresholds.mdx b/services/console/src/content/explanation/thresholds.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Thresholds & Alerts"
+description: "Overview of using thresholds to catch performance regressions in code benchmarks with alerts"
 heading: "Thresholds & Alerts"
 sortOrder: 4
 ---

diff --git a/services/console/src/content/how_to/github-actions.mdx b/services/console/src/content/how_to/github-actions.mdx
@@ -1,5 +1,6 @@
 ---
 title: "GitHub Actions"
+description: "Use Bencher in GitHub Actions for continuous benchmarking on pull requests"
 heading: "How to use Bencher in GitHub Actions"
 sortOrder: 3
 ---

diff --git a/services/console/src/content/how_to/gitlab-ci-cd.mdx b/services/console/src/content/how_to/gitlab-ci-cd.mdx
@@ -1,5 +1,6 @@
 ---
 title: "GitLab CI/CD"
+description: "Use Bencher in GitLab CI/CD for continuous benchmarking on merge requests"
 heading: "How to use Bencher in GitLab CI/CD"
 sortOrder: 4
 ---

diff --git a/services/console/src/content/how_to/install-cli.mdx b/services/console/src/content/how_to/install-cli.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Install CLI"
+description: "Install the bencher CLI for use both locally and in continuous benchmarking"
 heading: "How to Install bencher CLI"
 sortOrder: 1
 ---

diff --git a/services/console/src/content/how_to/track-benchmarks.mdx b/services/console/src/content/how_to/track-benchmarks.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Track Benchmarks"
+description: "Catch code benchmark performance regressions with historical continuous benchmarking or relative continuous benchmarking"
 heading: "How to use Bencher to Track Benchmarks"
 sortOrder: 2
 ---

diff --git a/services/console/src/content/legal/license.mdx b/services/console/src/content/legal/license.mdx
@@ -1,5 +1,6 @@
 ---
 title: "License Agreement"
+description: "The license agreement for the Bencher software"
 heading: "Bencher License Agreement"
 sortOrder: 3
 ---

diff --git a/services/console/src/content/legal/plus.mdx b/services/console/src/content/legal/plus.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Plus License"
+description: "The license agreement for Bencher Plus software"
 heading: "Bencher Plus License"
 sortOrder: 5
 ---

diff --git a/services/console/src/content/legal/privacy.mdx b/services/console/src/content/legal/privacy.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Privacy Policy"
+description: "The privacy agreement for Bencher software and services"
 heading: "Bencher Privacy Policy"
 sortOrder: 2
 ---

diff --git a/services/console/src/content/legal/subscription.mdx b/services/console/src/content/legal/subscription.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Subscription Agreement"
+description: "The subscription agreement for Bencher software and services"
 heading: "Bencher Subscription Agreement"
 sortOrder: 4
 ---

diff --git a/services/console/src/content/legal/terms-of-use.mdx b/services/console/src/content/legal/terms-of-use.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Website Terms of Use"
+description: "The terms of use agreement for the Bencher website"
 heading: "Bencher Website Terms of Use"
 sortOrder: 1
 ---

diff --git a/services/console/src/content/reference/changelog.mdx b/services/console/src/content/reference/changelog.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Changelog"
+description: "Bencher release changelog"
 heading: "Bencher Changelog"
 sortOrder: 4
 ---

diff --git a/services/console/src/content/reference/prior-art.mdx b/services/console/src/content/reference/prior-art.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Prior Art"
+description: "Collection of code benchmark tracking, comparison, and harness tools and documentation for continuous benchmarking"
 heading: "Prior Art"
 sortOrder: 2
 ---

diff --git a/services/console/src/content/reference/roadmap.mdx b/services/console/src/content/reference/roadmap.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Roadmap"
+description: "Roadmap for Bencher continuous benchmarking suite"
 heading: "Bencher Roadmap"
 sortOrder: 3
 ---