diff --git a/docs/resume/establish-spread-docs.md b/docs/resume/establish-spread-docs.md new file mode 100644 index 0000000..ee4ff41 --- /dev/null +++ b/docs/resume/establish-spread-docs.md @@ -0,0 +1,54 @@ +--- +title: PcVue assessment +description: An assessment of the documentation provided by PcVue. +hide: + # - toc + - navigation + - search +--- + + + +> ### Brief
+> **February 2022**
+> Establish the documentation function at SPREAD. + +:simple-materialformkdocs: MkDocs Material | :material-graphql: GraphQL | :material-language-javascript: JavaScript | :material-language-python: Python | :simple-jinja: Jinja | :material-language-markdown: MarkDown | :simple-v: Vale | :simple-githubactions: GitHub Actions | :material-docker: Docker + +![An image of the current version of the SPREAD documentation site](/src/spread-docs-v3-3456x2170.png){ height=300px } + +## Challenge + +Mambu Process Orchestrator - a white-labelled product built on top of the Corezoid low-code engine - had no documentation, but was already being used by clients. Some with highly complex workflows taht were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukranian company, who were under strain following the invasion by Russia in the same time period. + +## Solution + +Partner with Corezoid to help them develop their documentation alongside ours. Get field-tested best practices from clients who were using the tool. Ask the Solution Engineers to sketch out the most urgent work needed and teh scope they cover when workign with clients. Compile a documentation set in the shortest time possible to fill this documentation gap. + +
See the site
 + +--- + +
See my résume
 +
+ +
+ linkedin/gugulet-hu +
+ + +
+ gugulet.hu/dev +
+ +
\ No newline at end of file diff --git a/docs/resume/mambu-cli.md b/docs/resume/mambu-cli.md new file mode 100644 index 0000000..5bf593c --- /dev/null +++ b/docs/resume/mambu-cli.md @@ -0,0 +1,53 @@ +--- +title: Mambu CLI +description: Documentation that I did in a CLI. +hide: + # - toc + - navigation + - search +--- + + + +> ### Brief
+> **November 2023**
+> Create documentation for a command-line interface (CLI) used by banking engineering teams to perform actions in Mambu. + +:material-language-typescript: TypeScript | :material-nodejs: NodeJS + + +![An image of the Mambu CLI](/src/mambu-cli-1638x1355.jpg){ height=300px } + +## Challenge + +Document the command-line context as efficiently as possible, with little support from the developing team. Mambu CLI was in prototype and the team had no time to help me document the commands, flags, topics, and functioning of the CLI. + +## Solution + +Embedded documentation with the engineering team, where I was part of the race to beta. Engineers would develop a feature alongside me and I would be in the code documenting. This involved working in TypeScript and translating the concepts and trials engineers were developing with them. + +--- + +
See my résume
 +
+ +
+ linkedin/gugulet-hu +
+ + +
+ gugulet.hu/dev +
+ +
\ No newline at end of file diff --git a/docs/resume/mambu-process-orchestrator.md b/docs/resume/mambu-process-orchestrator.md new file mode 100644 index 0000000..61c91f5 --- /dev/null +++ b/docs/resume/mambu-process-orchestrator.md @@ -0,0 +1,54 @@ +--- +title: Mambu Process Orchestrator +description: An assessment of the documentation provided by PcVue. +hide: + # - toc + - navigation + - search +--- + + + +> ### Brief
+> **March 2021**
+> Own the documentation for the low-code orchestrator for integrations into banking services. + +:simple-hugo: Hugo + +![An image of a process in the Mambu Process Orchestartor](/src/mpo-complex-process-2355x1237.png){ height=300px } + +## Challenge + +Mambu Process Orchestrator - a white-labelled product built on top of the Corezoid low-code engine - had no documentation, but was already being used by clients. Some with highly complex workflows taht were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukranian company, who were under strain following the invasion by Russia in the same time period. + +## Solution + +Partner with Corezoid to help them develop their documentation alongside ours. Get field-tested best practices from clients who were using the tool. Ask the Solution Engineers to sketch out the most urgent work needed and teh scope they cover when workign with clients. Compile a documentation set in the shortest time possible to fill this documentation gap. + +
Read the documentation set
 + +--- + +
See my résume
 +
+ +
+ linkedin/gugulet-hu +
+ + +
+ gugulet.hu/dev +
+ +
\ No newline at end of file diff --git a/docs/src/mambu-cli-1638x1355.jpg b/docs/src/mambu-cli-1638x1355.jpg new file mode 100644 index 0000000..0f87e90 Binary files /dev/null and b/docs/src/mambu-cli-1638x1355.jpg differ diff --git a/docs/src/mpo-complex-process-2355x1237.png b/docs/src/mpo-complex-process-2355x1237.png new file mode 100644 index 0000000..64a743c Binary files /dev/null and b/docs/src/mpo-complex-process-2355x1237.png differ diff --git a/docs/src/spread-docs-v1-3024x1890.png b/docs/src/spread-docs-v1-3024x1890.png new file mode 100644 index 0000000..9c91380 Binary files /dev/null and b/docs/src/spread-docs-v1-3024x1890.png differ diff --git a/docs/src/spread-docs-v2-3024x1890.png b/docs/src/spread-docs-v2-3024x1890.png new file mode 100644 index 0000000..84dae64 Binary files /dev/null and b/docs/src/spread-docs-v2-3024x1890.png differ diff --git a/docs/src/spread-docs-v3-3456x2170.png b/docs/src/spread-docs-v3-3456x2170.png new file mode 100644 index 0000000..e0777db Binary files /dev/null and b/docs/src/spread-docs-v3-3456x2170.png differ diff --git a/docs/src/spread-glossary-3456x2168.png b/docs/src/spread-glossary-3456x2168.png new file mode 100644 index 0000000..4eeafd1 Binary files /dev/null and b/docs/src/spread-glossary-3456x2168.png differ diff --git a/docs/src/stylesheets/g.css b/docs/src/stylesheets/g.css index 476490b..762baea 100644 --- a/docs/src/stylesheets/g.css +++ b/docs/src/stylesheets/g.css @@ -44,11 +44,11 @@ a.md-header__button { /* Change colour of search highlighting. */ .md-search-result__link:focus, .md-search-result__link:hover { - background-color: var(--secondary-colour); + background-color: var(--transparent); } .md-typeset mark { - background-color: var(--secondary-colour); + background-color: var(--transparent); } /* This was creating an annoying space at the top. */ @@ -61,6 +61,11 @@ article.md-content__inner.md-typeset:after { max-width: none; } +/* Hide the repo stuff */ +.md-source { + display: none !important; +} + /***************************** * BUTTON *****************************/ diff --git a/mkdocs.yml b/mkdocs.yml index 912da40..e105628 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,6 +84,9 @@ nav: - Resumé: - resume.md - PcVue assessment: resume/pcvue.md + - Mambu CLI: resume/mambu-cli.md + - Mambu Process Orchestrator: resume/mambu-process-orchestrator.md + - SPREAD documentation: resume/establish-spread-docs.md plugins: # Plugin to enable the blog feature. [https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin]