TELUS Reference Architecture Documentation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github feat(README): add more details on purpose, process and structure (#173) Sep 5, 2018
analytics build(lint): add some linting meta files (#163) Aug 29, 2018
api build(lint): add some linting meta files (#163) Aug 29, 2018
assets fix(logo): logo elements are vertically aligned to the center of text ( Sep 5, 2018
content build(lint): add some linting meta files (#163) Aug 29, 2018
delivery chore(typos) Fixed typos and missing links (#171) Sep 5, 2018
development chore(typos) Fixed typos and missing links (#171) Sep 5, 2018
equipment docs: a few more updates on hardware docs (#169) Sep 5, 2018
performance docs(perf): updated performance overview (#166) Sep 5, 2018
process build(lint): add some linting meta files (#163) Aug 29, 2018
security build(lint): add some linting meta files (#163) Aug 29, 2018
testing Update seo.md (#182) Sep 18, 2018
.editorconfig build(lint): add some linting meta files (#163) Aug 29, 2018
.gitignore build(lint): add some linting meta files (#163) Aug 29, 2018
.remarkrc build(lint): add some linting meta files (#163) Aug 29, 2018
.template.md feat(README): add more details on purpose, process and structure (#173) Sep 5, 2018
.travis.yml build(lint): add some linting meta files (#163) Aug 29, 2018
LICENSE feat(license): add a license file! Mar 15, 2018
README.md fix(docs): corrected typo (#180) Sep 14, 2018
package-lock.json build(lint): add some linting meta files (#163) Aug 29, 2018
package.json build(lint): add some linting meta files (#163) Aug 29, 2018
renovate.json build(lint): add some linting meta files (#163) Aug 29, 2018

README.md

Reference Architecture

Why

Why does this exist?

This wiki acts as a source of truth for all the technical knowledge, software specifications, standards and architecture evolution.

This is a collaborative effort to document, track, and discuss digital software standards, tooling and practices, you are welcome to contribute and suggest changes, please follow the contribution guidelines and keep in mind: this repository is Open Source.

Who

Who is this for?

  • Existing Team Members: use as a reference, and contribute updates
  • New & Future Team Members: learn about our software development standards and practices
  • Partners: get familiar with our software standards and practices prior to project delivery commitments

What

What is the structure?

This is a Public & Open Source repository, with articles written in Markdown denoting various topics in the following categories:

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

How

How to take part?

Embody our Principles

  • Focus on Customer First
  • Value data over opinions
  • Deliver outcomes over outputs
  • Take risks and be lean
  • Build for quality and reuse
  • Be an owner
  • Attract and develop leaders
  • Embrace inclusivity
  • Strengthen communities

Open Source

Because we love our customers and we love our technology, we are evolving it, in full transparency!

We do all of this in public to truly embrace our customer first principles

In order to achieve this, we ensure no sensitive content is included, such as:

  • security & privacy policy violating content
  • content considered competitive intelligence
  • keys, tokens or credentials

Process & Contribution

A few avenues are made available for ensuring open collaboration and extended support for contributions to this standards wiki:

  • Technology Forum
    As a TELUS team member, you are welcome to use The Technology Forum as the official process to guide conversations and discussions around technology solutions, ideas, issue escalation, questions, knowledge sharing, and Reference Architecture evolution.

    We keep these two repositories separate, since this one is meant to be public and Open Source, whereas the Technology Forum will involve deep technical discussions and private information.

  • Open Contribution
    Simply use GitHub to make new pull-requests, start discussions, and contribute to active ones.
    However, if your contribution was not addressed in The Technology Forum the likelihood of adopting your suggested changes is minimal.

Format

All topics MUST follow the format outlined in this this template

GitHub

Using the GitHub repository itself, rather than the "GitHub Wikis" feature, or other "Wiki" software ensures:

  • version tracking, and usage of GitHub GUI features (blame, history, branches, diff, etc ...)
  • ability to publish into a static website using GitHub Pages
  • leverage branch locking, testing automation and other GitHub features only available in repos

Conformance

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.