From 8d8073bd755889f6ad3168899213822ecbf82cde Mon Sep 17 00:00:00 2001 From: Ian Cowley Date: Wed, 3 Jul 2024 12:38:43 +0200 Subject: [PATCH] adjust glossary --- content/en/_index.md | 22 ++++++------------- .../en/docs/getting-started/example-page.md | 2 +- data/termbase.yml | 7 +++--- 3 files changed, 11 insertions(+), 20 deletions(-) diff --git a/content/en/_index.md b/content/en/_index.md index aadc66c..54c9721 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -1,8 +1,8 @@ --- -title: Goldydocs +title: Hugo docs test site --- -{{< blocks/cover title="Welcome to Goldydocs: A Docsy Example Project!" image_anchor="top" height="full" >}} +{{< blocks/cover title="Welcome to Hugo docs test: A Docsy Example Project!" image_anchor="top" height="full" >}} Learn More @@ -13,7 +13,6 @@ title: Goldydocs {{< 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 @@ -23,7 +22,6 @@ been eating **your** porridge. to create your own real websites with [Docsy](https://docsy.dev)) {{% /blocks/lead %}} - {{% 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. @@ -31,26 +29,21 @@ The Goldydocs UI now shows chair size metrics by default. Please follow this space for updates! {{% /blocks/feature %}} - -{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}} +{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="" %}} 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/docsydocs" %}} +{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="" %}} For announcement of latest features etc. {{% /blocks/feature %}} - {{% /blocks/section %}} - {{% blocks/section %}} This is the second section {.h1 .text-center} {{% /blocks/section %}} - {{% blocks/section type="row" %}} {{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}} @@ -58,20 +51,19 @@ Get the Goldydocs app! {{% /blocks/feature %}} {{% blocks/feature icon="fab fa-github" title="Contributions welcome!" - url="https://github.com/google/docsy-example" %}} + url="" %}} 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" %}} + url="" %}} For announcement of latest features etc. {{% /blocks/feature %}} {{% /blocks/section %}} - {{% blocks/section %}} This is the another section {.h1 .text-center} -{{% /blocks/section %}} \ No newline at end of file +{{% /blocks/section %}} diff --git a/content/en/docs/getting-started/example-page.md b/content/en/docs/getting-started/example-page.md index 80b2840..7183d8e 100644 --- a/content/en/docs/getting-started/example-page.md +++ b/content/en/docs/getting-started/example-page.md @@ -7,7 +7,7 @@ categories: [Examples] tags: [test, sample, docs] --- -Some knowledge of {{< glossary-tooltip "tcp" >}} is useful to anyone who works with networks. +Find out how to use our {{< glossary-tooltip "api" >}} in this section of the documentation. {{% pageinfo %}} This is a placeholder page. Replace it with your own content. diff --git a/data/termbase.yml b/data/termbase.yml index 225f655..54f3547 100644 --- a/data/termbase.yml +++ b/data/termbase.yml @@ -1,10 +1,9 @@ - term: Abies definition: A genus of coniferous trees, properly called fir. category: nature -- term: Write the Docs - definition: A great place to discuss docs. - abbr: WtD - category: "docs" +- term: Application Programming Interface + definition: An API, or application programming interface, is a set of defined rules that enable different applications to communicate with each other. It acts as an intermediary layer that processes data transfers between systems, letting companies open their application data and functionality to external third-party developers, business partners, and internal departments within their companies. + abbr: API - term: Mean time to repair definition: The average time it takes to repair a failed component in a system. abbr: MTTR