jacobdeepak / reference-architecture Goto Github PK

Note: This is a work in progress, you are welcome to contribute and suggest changes, please follow the contribution guidelines

For new and existing team members, a single place where all the technical knowledge and platform specifications can be documented, tracked and debated.

The following sections and placeholder articles are the suggested starting point, more to be added, and updated throughout the drafting period.

TBD

• Project Template
• Contribution Model
• User Stories
  • Smaller Stories Are Faster

• Starter Kits
• Versioning
  • Changelog
  • Releases
• BFF (Backend-for-frontend)
• URI Templates & Structure
• Application Configuration

• CSS
  • SCSS
• JavaScript
  • Node.js
  • Isomorphic / Universal
  • Transpiling
    • ES6 / ES2015
    • ES2016
    • ES2017
  • Express
  • React
  • Redux

• NPM
• Yarn
• Webpack
• Enzyme
• Jest
• NewRelic
• Logging
• Caching
• Databases

• Code formatting
• Gitignore
• ESLint
• stylelint

• Overview
• RESTful Design
• Authorization Proxy
• Documentation Format

• Unit testing
• End to End testing
• Security testing
• Visual regression testing
• Accessibility testing
• Load testing
• SEO testing
• Analytics testing
• Consumer driven contract testing

• Continuous Integration
• Continuous Delivery
• Docker
• Kubernetes
• OpenShift
• Jenkins
• Secrets
• Inbound Proxies
• Shippy

• Isomorphic React Applications
  • Performance Baseline
  • API Optimization (Server Side)
  • Server Side Rendering
  • Image Optimization
  • CSS Optimization
  • Resource Hinting
  • Page Speed Insights
  • Automated Performance Testing

TBD

A thin and simple format documentation for technical resources, tools, platforms and decisions. Members can quickly and easily get context on "Why, What & How" for every part of our platform

A Github repository, with Markdown articles as content, (using the repository itself, rather than the "Github Wikis" Feature, this ensures:

• version tracking, and usage of github git gui features (blame, history, branches, diff, etc ...)
• publish into a static website using Github Pages
• leverage branch locking and other Github features only available in content repos

The format should loosely follow the following template:

# Subject Title

## Why

provide background information, problem description, challanges and/or goals

## What

The subject details, describe the tool / technology in detail, prefer linking to external sources if a 3rd party

## How

The **TELUS Digital context** of how we're using the described subject, provide **deep details** here, including usage manual, API documentation, operational guidelines, etc ...

## Who

`@` mention **teams** who are stakeholders or owners of described subject (see Github Members Groups)

## References

- [[link]] to internal references, and other wikis
- [[link]] to external references, documentation, product manuals and documentations