From 9372c6c1d99318dca58c6f00cf0b72a8b4b07789 Mon Sep 17 00:00:00 2001 From: Jeff Malnick Date: Thu, 24 Sep 2020 10:17:22 -0700 Subject: [PATCH] Docs: Release docs & changelog template (#419) * docs: add release downloads and notes page * docs: add changelog * build: remove redundant page Co-authored-by: Jeff Escalante --- CHANGELOG.md | 10 ++++++++++ website/data/docs-navigation.js | 7 ++++++- website/pages/docs/releases/downloads.mdx | 11 ----------- website/pages/docs/releases/index.mdx | 4 ++-- .../pages/docs/releases/release-notes/0_0_1.mdx | 15 +++++++++++++++ .../index.mdx} | 4 ++-- 6 files changed, 35 insertions(+), 16 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 website/pages/docs/releases/downloads.mdx create mode 100644 website/pages/docs/releases/release-notes/0_0_1.mdx rename website/pages/docs/releases/{release-notes.mdx => release-notes/index.mdx} (51%) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..c114464dd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Boundary CHANGELOG +Canonical reference for changes, improvments, and bugfixes for Boundary. + +## 0.0.1 + +CHANGES: + +IMPROVEMENTS: + +BUG FIXES: diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 8cb50e028..2b5738dce 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -83,7 +83,12 @@ export default [ }, { category: 'releases', - content: ['release-notes', 'downloads'], + content: [ + { + category: 'release-notes', + content: ['0_0_1'], + }, + ], }, '---', diff --git a/website/pages/docs/releases/downloads.mdx b/website/pages/docs/releases/downloads.mdx deleted file mode 100644 index d6afeb827..000000000 --- a/website/pages/docs/releases/downloads.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: docs -page_title: Downloads -sidebar_title: Downloads -description: |- - Boundary downloads for releases ---- - -# Downloads - -Lorum ipsum diff --git a/website/pages/docs/releases/index.mdx b/website/pages/docs/releases/index.mdx index b08b34046..82b67cf79 100644 --- a/website/pages/docs/releases/index.mdx +++ b/website/pages/docs/releases/index.mdx @@ -6,6 +6,6 @@ description: |- Boundary releases --- -# Overview +# Downloads -Boundary releases... +Downloads of Boundary can be found on the [HashiCorp Release Page](https://releases.hashicorp.com/boundary/). diff --git a/website/pages/docs/releases/release-notes/0_0_1.mdx b/website/pages/docs/releases/release-notes/0_0_1.mdx new file mode 100644 index 000000000..99105d447 --- /dev/null +++ b/website/pages/docs/releases/release-notes/0_0_1.mdx @@ -0,0 +1,15 @@ +--- +layout: docs +page_title: 0.0.1 +sidebar_title: 0.0.1 +description: |- + Boundary release notes for 0.0.1 +--- + +# Highlights + +# What's Changed + +--- + +For more information, please consult [Boundary's Changelog](https://github.com/hashicorp/boundary/blob/master/CHANGELOG.md) diff --git a/website/pages/docs/releases/release-notes.mdx b/website/pages/docs/releases/release-notes/index.mdx similarity index 51% rename from website/pages/docs/releases/release-notes.mdx rename to website/pages/docs/releases/release-notes/index.mdx index 7ac11e871..ff1ea4d8e 100644 --- a/website/pages/docs/releases/release-notes.mdx +++ b/website/pages/docs/releases/release-notes/index.mdx @@ -3,9 +3,9 @@ layout: docs page_title: Release Notes sidebar_title: Release Notes description: |- - Boundary Release Notes + Boundary release notes --- # Release Notes -Lorum ipsum +The side bar to the right has release notes for all major releases of Boundary.