-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Joe Heaton
committed
Jan 12, 2023
1 parent
ff0df20
commit 31149c6
Showing
10 changed files
with
127 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Team | ||
--- | ||
|
||
- Kim, Project Manager | ||
- Bim, Developer | ||
- Jim, Senior Engineer | ||
- Tim, Engineer |
5 changes: 5 additions & 0 deletions
5
content/en/docs/Agile Project 0001/Sprints/Sprint 001/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: "Sprint #001" | ||
description: Project kickoff! | ||
--- | ||
|
14 changes: 14 additions & 0 deletions
14
content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-001.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
29 changes: 29 additions & 0 deletions
29
content/en/docs/Agile Project 0001/Sprints/Sprint 001/task-002.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 ( | ||
<Container> | ||
<Layout> | ||
<Component {...pageProps} /> | ||
</Layout> | ||
</Container> | ||
); | ||
} | ||
} | ||
|
||
export default MyApp; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Sprints | ||
icon: "fas fa-running" | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
- <i class="fas fa-book-open"></i> [Docsy docs](https://www.docsy.dev/docs/) | ||
- <i class="fas fa-code-branch"></i> [Docsy repo](https://github.com/google/docsy/) | ||
- <i class="fas fa-code-branch"></i> [Docsy Example repo](https://github.com/google/docsy-example) | ||
- <i class="fas fa-code-branch"></i> [Docsy Example repo](https://github.com/google/docsy-example) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: "Example Ltd." | ||
icon: "fas fa-briefcase" | ||
description: Company documentation | ||
--- | ||
|