Docsy 0.7.0 and BSv5.2 updates (#221)

google · Jun 12, 2023 · 7c1c866 · 7c1c866
1 parent e4f460d
commit 7c1c866
Show file tree

Hide file tree

Showing 44 changed files with 220 additions and 339 deletions.
diff --git a/content/en/_index.html → content/en/_index.md b/content/en/_index.html → content/en/_index.md
@@ -1,30 +1,30 @@
-+++
-title = "Goldydocs"
-linkTitle = "Goldydocs"
-
-+++
-
-{{< blocks/cover title="Welcome to Goldydocs: A Docsy Example Project!" image_anchor="top" height="full" color="orange" >}}
-<div class="mx-auto">
-	<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
-		Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
-	</a>
-	<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy-example">
-		Download <i class="fab fa-github ml-2 "></i>
-	</a>
-	<p class="lead mt-5">Porridge temperature assessment - in the cloud!</p>
-	{{< blocks/link-down color="info" >}}
-</div>
+---
+title: Goldydocs
+---
+
+{{< blocks/cover title="Welcome to Goldydocs: A Docsy Example Project!" image_anchor="top" height="full" >}}
+<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
+  Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
+</a>
+<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/google/docsy-example">
+  Download <i class="fab fa-github ms-2 "></i>
+</a>
+<p class="lead mt-5">Porridge temperature assessment &mdash; in the cloud!</p>
+{{< blocks/link-down color="info" >}}
 {{< /blocks/cover >}}
 
 
 {{% blocks/lead color="primary" %}}
-Goldydocs provides a single web UI providing visibility into porridge temperature, chair size, and bed softness metrics! You can even find out who's been eating **your** porridge.
+Goldydocs provides a single web UI providing visibility into porridge
+temperature, chair size, and bed softness metrics! You can even find out who's
+been eating **your** porridge.
 
-(Sadly, Goldydocs isn't a real project, but you can use this site as an example to create your own real websites with [Docsy](https://docsy.dev))
+(Sadly, Goldydocs isn't a real project, but you can use this site as an example
+to create your own real websites with [Docsy](https://docsy.dev))
 {{% /blocks/lead %}}
 
-{{< blocks/section color="dark" type="row" >}}
+
+{{% blocks/section color="dark" type="row" %}}
 {{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}}
 The Goldydocs UI now shows chair size metrics by default.
 
@@ -42,40 +42,36 @@
 {{% /blocks/feature %}}
 
 
-{{< /blocks/section >}}
-
+{{% /blocks/section %}}
 
-{{< blocks/section >}}
-<div class="col">
-<h1 class="text-center">This is the second Section</h1>
-</div>
 
-{{< /blocks/section >}}
+{{% blocks/section %}}
+This is the second section
+{.h1 .text-center}
+{{% /blocks/section %}}
 
 
+{{% blocks/section type="row" %}}
 
-{{< blocks/section type="row" >}}
 {{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
 Get the Goldydocs app!
 {{% /blocks/feature %}}
 
-
-{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
-We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
+{{% blocks/feature icon="fab fa-github" title="Contributions welcome!"
+    url="https://github.com/google/docsy-example" %}}
+We do a [Pull Request](https://github.com/google/docsy-example/pulls)
+contributions workflow on **GitHub**. New users are always welcome!
 {{% /blocks/feature %}}
 
-
-{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}}
+{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!"
+    url="https://twitter.com/GoHugoIO" %}}
 For announcement of latest features etc.
 {{% /blocks/feature %}}
 
+{{% /blocks/section %}}
 
-{{< /blocks/section >}}
-
-{{< blocks/section >}}
-
-<div class="col-12">
-<h1 class="text-center">This is another Section</h1>
-</div>
 
-{{< /blocks/section >}}
+{{% blocks/section %}}
+This is the another section
+{.h1 .text-center}
+{{% /blocks/section %}}
diff --git a/content/en/about/_index.html b/content/en/about/_index.html
diff --git a/content/en/about/index.md b/content/en/about/index.md
@@ -0,0 +1,35 @@
+---
+title: About Goldydocs
+linkTitle: About
+menu: {main: {weight: 10}}
+---
+
+{{% blocks/cover title="About Goldydocs" image_anchor="bottom" height="auto" %}}
+
+A sample site using the Docsy Hugo theme.
+{.mt-5}
+
+{{% /blocks/cover %}}
+
+{{% blocks/lead %}}
+
+Goldydocs is a sample site using the [Docsy](https://github.com/google/docsy)
+Hugo theme that shows what it can do and provides you with a template site
+structure. It’s designed for you to clone and edit as much as you like. See the
+different sections of the documentation and site for more ideas.
+
+{{% /blocks/lead %}}
+
+{{% blocks/section %}}
+
+# This is another section
+{.text-center}
+
+{{% /blocks/section %}}
+
+{{% blocks/section %}}
+
+# This is another section
+{.text-center}
+
+{{% /blocks/section %}}
diff --git a/content/en/blog/_index.md b/content/en/blog/_index.md
@@ -1,13 +1,8 @@
 ---
-title: "Docsy Blog"
-linkTitle: "Blog"
-menu:
-  main:
-    weight: 30
+title: Blog
+menu: {main: {weight: 30}}
 ---
 
-
 This is the **blog** section. It has two categories: News and Releases.
 
 Files in these directories will be listed in reverse chronological order.
-
diff --git a/content/en/blog/news/_index.md b/content/en/blog/news/_index.md
@@ -1,8 +1,4 @@
-
 ---
-title: "News About Docsy"
-linkTitle: "News"
+title: News
 weight: 20
 ---
-
-
diff --git a/content/en/blog/news/first-post/index.md b/content/en/blog/news/first-post/index.md
@@ -1,14 +1,16 @@
 ---
 date: 2018-10-06
-title: "Easy documentation with Docsy"
-linkTitle: "Announcing Docsy"
-description: "The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch"
+title: Easy documentation with Docsy
+linkTitle: Announcing Docsy
+description: >
+  The Docsy Hugo theme lets project maintainers and contributors focus on content,
+  not on reinventing a website infrastructure from scratch
 author: Riona MacNamara ([@rionam](https://twitter.com/bepsays))
 resources:
-- src: "**.{png,jpg}"
-  title: "Image #:counter"
-  params:
-    byline: "Photo: Riona MacNamara / CC-BY-CA"
+  - src: "**.{png,jpg}"
+    title: "Image #:counter"
+    params:
+      byline: "Photo: Riona MacNamara / CC-BY-CA"
 ---
 
 **This is a typical blog post that includes images.**

diff --git a/content/en/blog/news/second-post.md b/content/en/blog/news/second-post.md
@@ -1,10 +1,9 @@
-
 ---
-title: "The second blog post"
-linkTitle: "Second blog post"
+title: Second blog post
 date: 2018-10-06
 description: >
-  A short lead description about this content page. Text here can also be **bold** or _italic_ and can even be split over multiple paragraphs.
+  A short lead description about this content page. Text here can also be
+  **bold** or _italic_ and can even be split over multiple paragraphs.
 ---
 
 Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com) should be blue with no underlines (unless hovered over).

diff --git a/content/en/blog/releases/_index.md b/content/en/blog/releases/_index.md
@@ -1,8 +1,4 @@
-
 ---
-title: "New Releases"
-linkTitle: "Releases"
+title: Releases
 weight: 20
 ---
-
-
diff --git a/content/en/blog/releases/in-depth-monoliths-detailed-spec.md b/content/en/blog/releases/in-depth-monoliths-detailed-spec.md
@@ -1,10 +1,9 @@
-
 ---
-title: "Another Great Release"
-linkTitle: "Release New Features"
+title: Another Great Release
 date: 2018-01-04
 description: >
-  A short lead description about this content page. Text here can also be **bold** or _italic_ and can even be split over multiple paragraphs.
+  A short lead description about this content page. Text here can also be
+  **bold** or _italic_ and can even be split over multiple paragraphs.
 ---
 
 Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com) should be blue with no underlines (unless hovered over).

diff --git a/content/en/community/_index.md b/content/en/community/_index.md
@@ -1,8 +1,6 @@
 ---
 title: Community
-menu:
-  main:
-    weight: 40
+menu: {main: {weight: 40}}
 ---
 
 <!--add blocks of content here to add more sections to the community page -->
diff --git a/content/en/docs/Concepts/_index.md b/content/en/docs/Concepts/_index.md
@@ -1,9 +1,8 @@
 ---
-title: "Concepts"
-linkTitle: "Concepts"
+title: Concepts
 weight: 4
 description: >
-  What does your user need to understand about your project in order to use it - or potentially contribute to it? 
+  What does your user need to understand about your project in order to use it - or potentially contribute to it?
 ---
 
 {{% pageinfo %}}
@@ -13,5 +12,3 @@ This is a placeholder page that shows you how to use this template site.
 For many projects, users may not need much information beyond the information in the [Overview](/docs/overview/), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.
 
 Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.
-
-
diff --git a/content/en/docs/Contribution guidelines/_index.md b/content/en/docs/Contribution guidelines/_index.md
@@ -1,9 +1,7 @@
 ---
-title: "Contribution Guidelines"
-linkTitle: "Contribution Guidelines"
+title: Contribution Guidelines
 weight: 10
-description: >
-  How to contribute to the docs
+description: How to contribute to the docs
 ---
 
 {{% pageinfo %}}
@@ -13,10 +11,10 @@ Don't forget to link to your own doc repo rather than our example site! Also mak
 {{% /pageinfo %}}
 
 We use [Hugo](https://gohugo.io/) to format and generate our website, the
-[Docsy](https://github.com/google/docsy) theme for styling and site structure, 
-and [Netlify](https://www.netlify.com/) to manage the deployment of the site. 
-Hugo is an open-source static site generator that provides us with templates, 
-content organisation in a standard directory structure, and a website generation 
+[Docsy](https://github.com/google/docsy) theme for styling and site structure,
+and [Netlify](https://www.netlify.com/) to manage the deployment of the site.
+Hugo is an open-source static site generator that provides us with templates,
+content organisation in a standard directory structure, and a website generation
 engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.
 
 All submissions, including submissions by project members, require review. We
@@ -32,15 +30,15 @@ updates:
 
 1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) on GitHub.
 1. Make your changes and send a pull request (PR).
-1. If you're not yet ready for a review, add "WIP" to the PR name to indicate 
-  it's a work in progress. (**Don't** add the Hugo property 
-  "draft = true" to the page front matter, because that prevents the 
+1. If you're not yet ready for a review, add "WIP" to the PR name to indicate
+  it's a work in progress. (**Don't** add the Hugo property
+  "draft = true" to the page front matter, because that prevents the
   auto-deployment of the content preview described in the next point.)
 1. Wait for the automated PR workflow to do some checks. When it's ready,
   you should see a comment like this: **deploy/netlify — Deploy preview ready!**
 1. Click **Details** to the right of "Deploy preview ready" to see a preview
   of your updates.
-1. Continue updating your doc and pushing your changes until you're happy with 
+1. Continue updating your doc and pushing your changes until you're happy with
   the content.
 1. When you're ready for a review, add a comment to the PR, and remove any
   "WIP" markers.

diff --git a/content/en/docs/Examples/_index.md b/content/en/docs/Examples/_index.md
@@ -1,17 +1,13 @@
-
 ---
-title: "Examples"
-linkTitle: "Examples"
+title: Examples
 weight: 3
 date: 2017-01-05
-description: >
-  See your project in action!
+description: See your project in action!
 ---
 
 {{% pageinfo %}}
 This is a placeholder page that shows you how to use this template site.
 {{% /pageinfo %}}
 
-Do you have any example **applications** or **code** for your users in your repo or elsewhere? Link to your examples here.
-
-
+Do you have any example **applications** or **code** for your users in your repo
+or elsewhere? Link to your examples here.
diff --git a/content/en/docs/Getting started/_index.md b/content/en/docs/Getting started/_index.md
@@ -1,11 +1,9 @@
 ---
-categories: ["Examples", "Placeholders"]
-tags: ["test","docs"] 
-title: "Getting Started"
-linkTitle: "Getting Started"
+title: Getting Started
+description: What does your user need to know to try your project?
+categories: [Examples, Placeholders]
+tags: [test, docs]
 weight: 2
-description: >
-  What does your user need to know to try your project?
 ---
 
 {{% pageinfo %}}