Finished first draft of Resume page.
This commit is contained in:
g_it
parent
3f38f601e9
commit
b6b011918e
GPG key ID:
A2B0A7C06A054627
30 changed files with 719 additions and 518 deletions
|
|
@ -1,91 +0,0 @@
|
|||
---
|
||||
title: Establish SPREAD documentation
|
||||
description: An overview of how I established the documentation function at SPREAD.
|
||||
hide:
|
||||
# - toc
|
||||
- navigation
|
||||
- search
|
||||
---
|
||||
|
||||
<style>
|
||||
img {
|
||||
border: 0.5px solid #ededed;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
div.tooling {
|
||||
margin: 1.5em 0;
|
||||
}
|
||||
|
||||
div.tooling p {
|
||||
font-family: var(--secondary-font) !important;
|
||||
font-weight: bold;
|
||||
}
|
||||
</style>
|
||||
|
||||
> ### Brief<br>
|
||||
>
|
||||
> **February 2022**<br>
|
||||
> Establish the documentation function at SPREAD.
|
||||
|
||||
<div class='tooling' markdown>: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</div>
|
||||
|
||||
{ height=300px }
|
||||
|
||||
## Challenge
|
||||
|
||||
There was no documentation, except for a few Confluence pages put together by engineers. The challenge was to create a documentation site, create the processes and pipelines to maintain it, and to write the content. The task was made more difficult by the fact that the product was constantly changing and I had engineering time to lean on.
|
||||
|
||||
## Solution
|
||||
|
||||
**In the first three months:**
|
||||
|
||||
- Evaluated and selected options for the technical infrastructure.
|
||||
- Socialized the newly established function in the company.
|
||||
- Created the internal website.
|
||||
- Created the initial build pipelines.
|
||||
- Got to 50% product coverage.
|
||||
- Wrote an initial style guide for general contributions
|
||||
|
||||
{ height=300px }
|
||||
|
||||
**In the second quarter:**
|
||||
|
||||
- Got product coverage to 90%.
|
||||
- Moved to multi-repo setup, where engineering teams "owned" their content and maintained updates.
|
||||
- Built the linting pipelines for general contributions.
|
||||
- Document white-labelled products with internal customisations.
|
||||
|
||||
{ height=300px }
|
||||
|
||||
**Within the first year:**
|
||||
|
||||
- Publish the documentation site publicly.
|
||||
- Publish the SPREAD glossary of terms.
|
||||
- Create course content for new users.
|
||||
|
||||
**Within the last year:**
|
||||
|
||||
- Move to a mono-repo setup.
|
||||
- Create more course content.
|
||||
- Add AI enhancements to the build pipeline.
|
||||
- Better monitoring of product changes.
|
||||
- Re-start initiative for more people to write documentation.
|
||||
|
||||
<a href='https://docs.spread.ai' target='_blank'><div class="button">See the site</div></a>
|
||||
|
||||
---
|
||||
|
||||
<a href="https://gugulet.hu/resume" target="_blank" ><div class="button">See my résume</div></a>
|
||||
<div class='meta-icons'>
|
||||
<a href='https://linkedin.com/in/gugulet-hu' target='_blank' >
|
||||
<div>
|
||||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M19 3a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2zm-.5 15.5v-5.3a3.26 3.26 0 0 0-3.26-3.26c-.85 0-1.84.52-2.32 1.3v-1.11h-2.79v8.37h2.79v-4.93c0-.77.62-1.4 1.39-1.4a1.4 1.4 0 0 1 1.4 1.4v4.93zM6.88 8.56a1.68 1.68 0 0 0 1.68-1.68c0-.93-.75-1.69-1.68-1.69a1.69 1.69 0 0 0-1.69 1.69c0 .93.76 1.68 1.69 1.68m1.39 9.94v-8.37H5.5v8.37z'></path></svg></span> linkedin/gugulet-hu
|
||||
</div>
|
||||
</a>
|
||||
<a href='https://gugulet.hu/technical/dev/explore/repos' target='_blank' >
|
||||
<div>
|
||||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M2.6 10.59 8.38 4.8l1.69 1.7c-.24.85.15 1.78.93 2.23v5.54c-.6.34-1 .99-1 1.73a2 2 0 0 0 2 2 2 2 0 0 0 2-2c0-.74-.4-1.39-1-1.73V9.41l2.07 2.09c-.07.15-.07.32-.07.5a2 2 0 0 0 2 2 2 2 0 0 0 2-2 2 2 0 0 0-2-2c-.18 0-.35 0-.5.07L13.93 7.5a1.98 1.98 0 0 0-1.15-2.34c-.43-.16-.88-.2-1.28-.09L9.8 3.38l.79-.78c.78-.79 2.04-.79 2.82 0l7.99 7.99c.79.78.79 2.04 0 2.82l-7.99 7.99c-.78.79-2.04.79-2.82 0L2.6 13.41c-.79-.78-.79-2.04 0-2.82'></path></svg></span> gugulet.hu/dev
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
---
|
||||
title: Mambu CLI
|
||||
description: Documentation that I did in a CLI.
|
||||
hide:
|
||||
# - toc
|
||||
- navigation
|
||||
- search
|
||||
---
|
||||
|
||||
<style>
|
||||
img {
|
||||
border: 0.5px solid #ededed;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
div.tooling {
|
||||
margin: 1.5em 0;
|
||||
}
|
||||
|
||||
div.tooling p {
|
||||
font-family: var(--secondary-font) !important;
|
||||
font-weight: bold;
|
||||
}
|
||||
</style>
|
||||
|
||||
> ### Brief<br>
|
||||
>
|
||||
> **November 2023**<br>
|
||||
> Create documentation for a command-line interface (CLI) used by banking engineering teams to perform actions in Mambu.
|
||||
|
||||
<div class='tooling' markdown>:material-language-typescript: TypeScript ⋅ :material-nodejs: NodeJS</div>
|
||||
|
||||
{ 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.
|
||||
|
||||
---
|
||||
|
||||
<a href="https://gugulet.hu/resume" target="_blank" ><div class="button">See my résume</div></a>
|
||||
<div class='meta-icons'>
|
||||
<a href='https://linkedin.com/in/gugulet-hu' target='_blank' >
|
||||
<div>
|
||||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M19 3a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2zm-.5 15.5v-5.3a3.26 3.26 0 0 0-3.26-3.26c-.85 0-1.84.52-2.32 1.3v-1.11h-2.79v8.37h2.79v-4.93c0-.77.62-1.4 1.39-1.4a1.4 1.4 0 0 1 1.4 1.4v4.93zM6.88 8.56a1.68 1.68 0 0 0 1.68-1.68c0-.93-.75-1.69-1.68-1.69a1.69 1.69 0 0 0-1.69 1.69c0 .93.76 1.68 1.69 1.68m1.39 9.94v-8.37H5.5v8.37z'></path></svg></span> linkedin/gugulet-hu
|
||||
</div>
|
||||
</a>
|
||||
<a href='https://gugulet.hu/technical/dev/explore/repos' target='_blank' >
|
||||
<div>
|
||||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M2.6 10.59 8.38 4.8l1.69 1.7c-.24.85.15 1.78.93 2.23v5.54c-.6.34-1 .99-1 1.73a2 2 0 0 0 2 2 2 2 0 0 0 2-2c0-.74-.4-1.39-1-1.73V9.41l2.07 2.09c-.07.15-.07.32-.07.5a2 2 0 0 0 2 2 2 2 0 0 0 2-2 2 2 0 0 0-2-2c-.18 0-.35 0-.5.07L13.93 7.5a1.98 1.98 0 0 0-1.15-2.34c-.43-.16-.88-.2-1.28-.09L9.8 3.38l.79-.78c.78-.79 2.04-.79 2.82 0l7.99 7.99c.79.78.79 2.04 0 2.82l-7.99 7.99c-.78.79-2.04.79-2.82 0L2.6 13.41c-.79-.78-.79-2.04 0-2.82'></path></svg></span> gugulet.hu/dev
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
|
@ -1,59 +0,0 @@
|
|||
---
|
||||
title: Mambu Process Orchestrator
|
||||
description: An overview of how I documented a feature set at Mambu.
|
||||
hide:
|
||||
# - toc
|
||||
- navigation
|
||||
- search
|
||||
---
|
||||
|
||||
<style>
|
||||
img {
|
||||
border: 0.5px solid #ededed;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
div.tooling {
|
||||
margin: 1.5em 0;
|
||||
}
|
||||
|
||||
div.tooling p {
|
||||
font-family: var(--secondary-font) !important;
|
||||
font-weight: bold;
|
||||
}
|
||||
</style>
|
||||
|
||||
> ### Brief<br>
|
||||
>
|
||||
> **March 2021**<br>
|
||||
> Own the documentation for the low-code orchestrator for integrations into banking services.
|
||||
|
||||
<div class='tooling' markdown>:simple-hugo: Hugo</div>
|
||||
|
||||
{ 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 that were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukrainian 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 the scope they cover when working with clients. Compile a documentation set in the shortest time possible to fill this documentation gap.
|
||||
|
||||
<a href='https://ecosystem.mambu.com/mpo/overview/' target='_blank'><div class="button"><abbr title='The set has largely been left unmaintained as this tool is scheduled for decomissioning.'>Read the documentation set</abbr></div></a>
|
||||
|
||||
---
|
||||
|
||||
<a href="https://gugulet.hu/resume" target="_blank" ><div class="button">See my résume</div></a>
|
||||
<div class='meta-icons'>
|
||||
<a href='https://linkedin.com/in/gugulet-hu' target='_blank' >
|
||||
<div>
|
||||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M19 3a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2zm-.5 15.5v-5.3a3.26 3.26 0 0 0-3.26-3.26c-.85 0-1.84.52-2.32 1.3v-1.11h-2.79v8.37h2.79v-4.93c0-.77.62-1.4 1.39-1.4a1.4 1.4 0 0 1 1.4 1.4v4.93zM6.88 8.56a1.68 1.68 0 0 0 1.68-1.68c0-.93-.75-1.69-1.68-1.69a1.69 1.69 0 0 0-1.69 1.69c0 .93.76 1.68 1.69 1.68m1.39 9.94v-8.37H5.5v8.37z'></path></svg></span> linkedin/gugulet-hu
|
||||
</div>
|
||||
</a>
|
||||
<a href='https://gugulet.hu/technical/dev/explore/repos' target='_blank' >
|
||||
<div>
|
||||
<span class='twemoji'><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M2.6 10.59 8.38 4.8l1.69 1.7c-.24.85.15 1.78.93 2.23v5.54c-.6.34-1 .99-1 1.73a2 2 0 0 0 2 2 2 2 0 0 0 2-2c0-.74-.4-1.39-1-1.73V9.41l2.07 2.09c-.07.15-.07.32-.07.5a2 2 0 0 0 2 2 2 2 0 0 0 2-2 2 2 0 0 0-2-2c-.18 0-.35 0-.5.07L13.93 7.5a1.98 1.98 0 0 0-1.15-2.34c-.43-.16-.88-.2-1.28-.09L9.8 3.38l.79-.78c.78-.79 2.04-.79 2.82 0l7.99 7.99c.79.78.79 2.04 0 2.82l-7.99 7.99c-.78.79-2.04.79-2.82 0L2.6 13.41c-.79-.78-.79-2.04 0-2.82'></path></svg></span> gugulet.hu/dev
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
Loading…
Add table
Add a link
Reference in a new issue