Skip to content

Commit

Permalink
Merge pull request #2 from matkuliak/mm/2024edit
Browse files Browse the repository at this point in the history
2024 Updates
  • Loading branch information
matkuliak authored Oct 9, 2024
2 parents f6f73a1 + 495f90d commit 2cfd34e
Show file tree
Hide file tree
Showing 321 changed files with 35 additions and 48,287 deletions.
42 changes: 28 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,54 @@ icon: home

# Welcome to my docs!

These pages are supposed to serve as a showcase of my work. It should be the second thing you read after my CV or LinkedIn. It is an edited fork of [FRINX's github](https://github.com/FRINXio/frinxio.github.io) that I developed and maintained. Feel free to look around.
These pages serve as a catalog of my work.
It should be the second thing you look at after my CV or [LinkedIn](https://www.linkedin.com/in/matej-matkuliak/).

:sparkles: [!badge text="My CV" target="blank"](https://github.com/matkuliak/matkuliak.github.io/blob/main/Matej_Ma%C5%A5kuliak_Technical_Writer.pdf) :sparkles:

So far I had an interesting experience as a technical writer. As time went it ranged from networking engineer to typical technical writer to content manager and reviewer. I was comfortable in this hybrid position. It however makes for a difficult explanation of what I do at times. Because of that, I try to summarize my responsibilities by frequency below:
### A few examples of content I have worked on:

- **Example tutorial** - Importing data from InfluxDB: https://cratedb.com/docs/guide/integrate/etl/influxdb.html
- **Example guide** - Data pipeline with Kafka and CrateDB: https://cratedb.com/docs/guide/integrate/etl/kafka-connect.html
- **Example community post** - Data analysis with Cluvio: https://community.cratedb.com/t/data-analysis-with-cluvio-and-cratedb/1571
- **Example blog post** - Analysis of ingestion improvements with vertical/horizontal scaling: https://cratedb.com/blog/ingesting-with-cratedb
- **DocsOps** - Implemented the documentation solution and workflows for [Frinx](https://docs.frinx.io/)
  - Automated [release notes](https://docs.frinx.io/frinx-uniconfig/release-notes/), pulling info directly from dev [commits](https://docs.frinx.io/frinx-uniconfig/release-notes/uniconfig-6.1.2/).

So far I've had a really diverse experience as a technical writer. As time went it
ranged from networking engineer to typical technical writer to content
manager and reviewer. I was comfortable in this hybrid position. It however
makes for a difficult explanation of what I do at times. Because of that, I
try to summarize my responsibilities by frequency below:

## My Responsibilities

### Routine tasks (daily to weekly occurrence)

**Development of new documentation** - In the process, I test the product myself and communicate with both product and development teams. Thanks to that I have experience in working on open-source projects with multiple collaborators. Tracking everything in collaboration tools like Jira.
**Development of new documentation**In the process, I test the product myself and communicate with both the product and development teams. Thanks to that, I have experience working on open-source projects with multiple collaborators, tracking everything in collaboration tools like Jira, GitHub Projects, etc.

For the documentation I like to use Retype. It allows to focus more on the content and less on the html and css. It's a tool that automatically generates beautiful pages from markdown code. It can also be configured to build and deploy every new commit automatically.
I'm a big proponent of the docs-as-code approach. Most of my experience is in [Sphinx](https://www.sphinx-doc.org/en/master/). However, it is slightly dated, depending on the use case, so when starting a fresh docs project, I like to use [Retype](https://retype.com/).

**Review** - In my experience, developers also write documentation regularly. When this happens, everything goes through me. We've put together a very solid review process to make the workflow as straightforward as it can be.
**Review** -  In my experience, developers also write documentation regularly. When this happens, I'm happy to help out.

**API development** - I regularly prepare and document API collections for internal training, new products or even for specific customer use-cases.
**API development** - I regularly prepare and document API collections for internal training, new products, or even specific customer use cases.

**UX input** - Due to my hybrid role I sometimes have a different perspective than a traditional developer which can lead to a UI adjustment or to the introduction of a new feature.
**UX input** - Due to my hybrid role, I sometimes have a different perspective than a traditional developer which can lead to a UI adjustment or the introduction of a new feature.

**Analytics** - Keeping an eye on our numbers in Google Analytics, reception of new guides and updates etc. Also included in our Ads focus and spending - Not a main guy on this but I was frequently included for input.
**Analytics** - Keeping an eye on SEO, our numbers in Google Analytics, reception of new guides and updates, etc. Also included in our Ads focus and spending.

### Less frequent tasks (every couple of weeks to a couple of months)

**Development of long-term content strategies.** We have multiple software products and content-related priorities need to shift in accordance with the priorities of product and development teams. Customer feedback is also a high priority for me, so that too influences what I focus on.
**Development of long-term content strategies.** - With multiple software products, content priorities shift based on the goals of the product and development teams. I also prioritize customer feedback, which significantly influences my focus areas.

**Releases** - We used to write release notes manually together with product and developer teams. I automated that process. Standardization of commit messages together with a script allowed us to pull release notes directly from Github commit history. E.g., https://docs.frinx.io/frinx-uniconfig/release-notes/uniconfig-5.0.7/
**Releases** - Frinx used to write release notes manually together with product and developer teams. I automated that process. Standardization of commit messages, together with a few scripts, allowed us to pull release notes directly from Github commit history. E.g., https://docs.frinx.io/frinx-uniconfig/release-notes/uniconfig-5.0.7/

**Website management** - I managed a ReactJS website. Changes weren't needed often as it wasn't main space for communication, but new content was added by me. https://frinx.io/
**Website management** - I managed a ReactJS website. Changes weren't needed often as it wasn't the main space for communication, but new content was added by me. https://frinx.io/

**Networking devices environment setup**- Products dealt with networking devices. I've worked with multiple vendors (Cisco, Juniper, Ciena, Huawei etc.). Thanks to my networking background I was often assigned to the beginning stages of projects. Get a sense of the scope of the project and the work that will be needed to be done.
**Networking devices environment setup** - I worked in the networking lab at one of the jobs. Worked with multiple vendors (Cisco, Juniper, Ciena, Huawei, etc.). Thanks to my networking background I was often assigned to the beginning stages of projects. Get a sense of the scope of the project and the work that will be needed to be done.

**Design** -Experience in Photoshop, Illustrator, InDesign for promotional documents.
**Design** - Experience in Photoshop, Illustrator, and InDesign for promotional documents.

**DevOps** - Work with VMs, preparation of the environment, allocation of resources. Also some Docker experience with debugging.
**DevOps** - Work with VMs (Proxmox), preparation of the environment, and allocation of resources. A good amount of work with dockerized applications (Docker/Kubernetes).

**CI/CD infrastructure** - I have experience with infrastructure work. Mainly Jenkins jobs for automated builds/tests and Artifactory for binaries storage.
Binary file removed frinx-machine/azure-ad/azure_api_permissions.png
Binary file not shown.
Binary file removed frinx-machine/azure-ad/azure_client_secret.png
Binary file not shown.
Binary file removed frinx-machine/azure-ad/azure_tenant.png
Binary file not shown.
Binary file not shown.
127 changes: 0 additions & 127 deletions frinx-machine/azure-ad/readme.md

This file was deleted.

Binary file not shown.
Binary file removed frinx-machine/getting-started/components.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user23.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user24.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user25.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user26.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user27.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user28.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user29.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user30.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user31.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/conductor_user32.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_0.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_1.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_10.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_12.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_13.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_14.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_15.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_16.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_17.png
Binary file not shown.
Binary file removed frinx-machine/getting-started/image_18.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_19.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_1_0.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_2.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_20.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_21.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_22.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_3.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_4.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_5.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_6.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_7.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_8.png
Diff not rendered.
Binary file removed frinx-machine/getting-started/image_9.png
Diff not rendered.
102 changes: 0 additions & 102 deletions frinx-machine/getting-started/introduction.rst-DEL

This file was deleted.

Loading

0 comments on commit 2cfd34e

Please sign in to comment.