https://github.com/webmaeistro/devz-docz
Aggregation of onboarding and general devz standards that I have gatherd over my career.
https://github.com/webmaeistro/devz-docz
development-workflow docs howto-tutorial onboarding onboarding-essential
Last synced: 11 months ago
JSON representation
Aggregation of onboarding and general devz standards that I have gatherd over my career.
- Host: GitHub
- URL: https://github.com/webmaeistro/devz-docz
- Owner: webmaeistro
- Created: 2020-09-30T14:28:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-30T14:53:01.000Z (over 5 years ago)
- Last Synced: 2025-02-07T01:46:23.882Z (about 1 year ago)
- Topics: development-workflow, docs, howto-tutorial, onboarding, onboarding-essential
- Language: Shell
- Homepage: https://webmaeistro.github.io/devz-docz/
- Size: 1.34 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Onboarding new devz / SWP
## Purpose
This is my thoughts and insights and opinions regarding engineering tools, processes, and practices. The problems and choices that I encounter in my day-to-day practice are rarely new. Having a straightforward way of applying the things I collectively know to the problems I face would be a source of great efficiency for me.
This collection of documents is intended to be simple and searchable, each one containing the essence of my observations and incorporated in docs improvments and opinions on a particular topic. Whilst any Frontkomer is free to edit these documents, there is some expectation that these are to be curated by the broad engineering community at Martin's experience. To that end, proposed changes should be submitted via a PR and SMEs will be identified to act as curators for particular areas of knowledge.
### Public repo
One question I might ask is whether or not this repo should be public? My inclination is to say yes and use it as a way of demonstrating to customers and potential hires what to expect from working with or for Martin's experience.
## Contents
* [Developer Tools & Practice](./developing/README.md) - Opinions and resources relating to the tools I use to do my work
* [Documentation](./documentation/README.md) - How to write effective documentation your users will read.
* [Web Development](./web/README.md) - Languages, frameworks and tools used to develop web applications
* [InfraSec](./infrasec/README.md) - Infrastructure and security are foundational disciplines for building and maintaining stable systems.
* [Templates](./templates/README.md) - "Ooh, ooh... I have a thing to add." Here's how to add to this Playbook
## Initial Setup
### Install Dependencies(Mac OS/linux)
brew update
brew install pre-commit
pre-commit install