From 31149c6646fa7fe95c7e1740f210690b70ccbb57 Mon Sep 17 00:00:00 2001 From: Joe Heaton Date: Thu, 12 Jan 2023 13:33:40 +0000 Subject: [PATCH] More example content --- .../Agile Project 0001/Planning/_index.md | 14 +++++++ .../docs/Agile Project 0001/Planning/team.md | 8 ++++ .../Sprints/Sprint 001/_index.md | 5 +++ .../Sprints/Sprint 001/task-001.md | 14 +++++++ .../Sprints/Sprint 001/task-002.md | 29 ++++++++++++++ .../docs/Agile Project 0001/Sprints/_index.md | 4 ++ content/en/docs/Agile Project 0001/_index.md | 38 +++++++++++++++++++ content/en/docs/Docsy project/_index.md | 8 ---- .../Documentation project/docsy/_index.md | 16 ++++---- content/en/docs/Example Ltd./_index.md | 6 +++ 10 files changed, 127 insertions(+), 15 deletions(-) create mode 100644 content/en/docs/Agile Project 0001/Planning/_index.md create mode 100644 content/en/docs/Agile Project 0001/Planning/team.md create mode 100644 content/en/docs/Agile Project 0001/Sprints/Sprint 001/_index.md create mode 100644 content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-001.md create mode 100644 content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-002.md create mode 100644 content/en/docs/Agile Project 0001/Sprints/_index.md create mode 100644 content/en/docs/Agile Project 0001/_index.md delete mode 100644 content/en/docs/Docsy project/_index.md create mode 100644 content/en/docs/Example Ltd./_index.md diff --git a/content/en/docs/Agile Project 0001/Planning/_index.md b/content/en/docs/Agile Project 0001/Planning/_index.md new file mode 100644 index 0000000..45f02eb --- /dev/null +++ b/content/en/docs/Agile Project 0001/Planning/_index.md @@ -0,0 +1,14 @@ +--- +title: Planning +icon: fas fa-map +--- + +ACME Ltd. is working on a next-gen corporate authentication system with synergy. + +| Tasks | Result | +| --- | --- | +| Send questionnaire to client | Emailed over by Jim | +| Respond to any questions | Had a call with their Project Manager regarding wording of Q2 | +| Recieve questionnaire back | ☑ | +| Build Team | [Team](team) | + diff --git a/content/en/docs/Agile Project 0001/Planning/team.md b/content/en/docs/Agile Project 0001/Planning/team.md new file mode 100644 index 0000000..b2bf7ab --- /dev/null +++ b/content/en/docs/Agile Project 0001/Planning/team.md @@ -0,0 +1,8 @@ +--- +title: Team +--- + +- Kim, Project Manager +- Bim, Developer +- Jim, Senior Engineer +- Tim, Engineer diff --git a/content/en/docs/Agile Project 0001/Sprints/Sprint 001/_index.md b/content/en/docs/Agile Project 0001/Sprints/Sprint 001/_index.md new file mode 100644 index 0000000..eb043c0 --- /dev/null +++ b/content/en/docs/Agile Project 0001/Sprints/Sprint 001/_index.md @@ -0,0 +1,5 @@ +--- +title: "Sprint #001" +description: Project kickoff! +--- + diff --git a/content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-001.md b/content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-001.md new file mode 100644 index 0000000..ca7d3e4 --- /dev/null +++ b/content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-001.md @@ -0,0 +1,14 @@ +--- +title: Task 001 +description: Create authentication model +--- + +```plantuml +@startuml +Alice -> Bob: Authentication Request +Bob --> Alice: Authentication Response + +Alice -> Bob: Another authentication Request +Alice <-- Bob: Another authentication Response +@enduml +``` diff --git a/content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-002.md b/content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-002.md new file mode 100644 index 0000000..9f8688f --- /dev/null +++ b/content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-002.md @@ -0,0 +1,29 @@ +--- +title: Task 002 +description: Create example front-end +--- + +The plan is to go with this approach, Javascript, HTML, pretty standard stuff. + +```js +// pages/_app.js +import React from 'react'; +import App, { Container } from 'next/app'; +import Layout from '../components/Layout'; + +class MyApp extends App { + render() { + const { Component, pageProps } = this.props; + + return ( + + + + + + ); + } +} + +export default MyApp; +``` diff --git a/content/en/docs/Agile Project 0001/Sprints/_index.md b/content/en/docs/Agile Project 0001/Sprints/_index.md new file mode 100644 index 0000000..4d2412e --- /dev/null +++ b/content/en/docs/Agile Project 0001/Sprints/_index.md @@ -0,0 +1,4 @@ +--- +title: Sprints +icon: "fas fa-running" +--- diff --git a/content/en/docs/Agile Project 0001/_index.md b/content/en/docs/Agile Project 0001/_index.md new file mode 100644 index 0000000..f0ee0da --- /dev/null +++ b/content/en/docs/Agile Project 0001/_index.md @@ -0,0 +1,38 @@ +--- +title: "Agile Project #1" +icon: "fas fa-coffee" +description: | + ACME Ltd. are working on a next-gen corporate authentication system with synergy. +--- + +The project is being run with Agile Sprints + +```mermaid +gantt + title Agile Project 0001 Sprints + dateFormat YYYY-MM-DD + excludes weekends + + section Discovery + Questionnaire :done, q1, 2022-01-01, 7d + Refine Results :done, q2, after q1, 7d + section Planning + Build Team :done, p1, after q1, 7d + + section Sprint 001 + Create Backlog :done, s001t0, after p1, 1d + Task 001 :active, s001t1, after s001t0, 7d + Task 002 :crit, s001t2, after s001t0, 7d + Task 003 :active, s001t3, after s001t0, 7d + Review Sprint 001 :s001r1, after s001t1, 1d + + section Sprint 002 + Refine Backlog :s002r0, after s001r1, 1d + Task 001 :s002t1, after s001r1, 7d + Task 002 :s002t2, after s001r1, 7d + Task 003 :s002t3, after s001r1, 7d + Review Sprint 002 :s002r1, after s002t1, 1d + + section Demo 001 + Demo :d001d1, after s002t1, 1d +``` diff --git a/content/en/docs/Docsy project/_index.md b/content/en/docs/Docsy project/_index.md deleted file mode 100644 index 5c5093a..0000000 --- a/content/en/docs/Docsy project/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Docsy project -description: | - Document usage of Docsy theme on Hugo -icon: "fas fa-atlas" ---- - -Docsy, how to deploy, update, etc.. \ No newline at end of file diff --git a/content/en/docs/Documentation project/docsy/_index.md b/content/en/docs/Documentation project/docsy/_index.md index 7c817f5..c61aaeb 100644 --- a/content/en/docs/Documentation project/docsy/_index.md +++ b/content/en/docs/Documentation project/docsy/_index.md @@ -1,17 +1,19 @@ --- -title: "Docsy" +title: "Docsy overview" +description: A quick overview of what makes Docsy useful --- -Docsy is a Hugo theme for documentation developed by a Googler and used on many large projects including [Kubernetes](https://kubernetes.io/), [Apache Airflow](https://airflow.apache.org/) & [gRPC](https://www.grpc.io/) to name a few. +Docsy is a Hugo theme for documentation developed by a Googler and is used on many large projects including [Kubernetes](https://kubernetes.io/), [Apache Airflow](https://airflow.apache.org/) & [gRPC](https://www.grpc.io/) to name a few. -Hugo websites are static generated, meaning the hosting platform need serve plain HTML/CSS/JS/Blobs files, while a Continuous Delivery pipeline regenerates on Git merges and pushes out updates. +Hugo websites are static generated, meaning the hosting platform need only serve plain HTML/CSS/JS/Asset blobs, while a CI/CD pipeline triggers on changes to the content repository. Content can be written in multiple formats but primarily Markdown, which is a simplified markup language for writing web content. -The theme is flexible and fully customizable, requiring only knowledge of Hugo and basic web development skills. Hugo itself is based on Go lang and directly uses Go's templating language and module system, making it familiar to anyone with Go experience. +- [CommonMark - Markdown Reference](https://commonmark.org/help/) covers the basic Markdown syntax +- [Markdown Guide - Extended Syntax](https://www.markdownguide.org/extended-syntax/) covers more capabilities, including tables, syntax highlighting & footnotes. -Content is authoried in Markdown, with support for tables, and allows for HTML inline. Docsy also packages Hugo Shortcodes which can make more complex functionality available, it's also possible to augment the Markdown renderer with Hooks. +The theme is flexible and fully customizable, requiring only knowledge of Hugo and basic web development skills. Hugo itself is based on Go lang and directly uses Go's templating language and module system, making it familiar to anyone with Go experience. -This site took 1 second to compile. +This site took <1 second to compile. - [Docsy docs](https://www.docsy.dev/docs/) - [Docsy repo](https://github.com/google/docsy/) -- [Docsy Example repo](https://github.com/google/docsy-example) \ No newline at end of file +- [Docsy Example repo](https://github.com/google/docsy-example) diff --git a/content/en/docs/Example Ltd./_index.md b/content/en/docs/Example Ltd./_index.md new file mode 100644 index 0000000..b9e515f --- /dev/null +++ b/content/en/docs/Example Ltd./_index.md @@ -0,0 +1,6 @@ +--- +title: "Example Ltd." +icon: "fas fa-briefcase" +description: Company documentation +--- +