Skip to main content

Developer Guide

ℹī¸ Overview​

The developer guide is a one-stop-shop for all things technical, within Rizing. The intent of this guide is to share content and help reduce barriers to information between lines of business, within Rizing.

Recommended topics:

Architecture​

Workflow Diagram

🚀 Getting Started​

Reading Recommendations​

If this is your first time here, we recommend reading the following topics, based on your situation:

Developer new hire​

  1. Review Rizing's Company overview
  2. Review Rizing's Coding Standards and Rules
  3. Review Rizing's Develpment Workflow, Source Control, Branching, and Versioning docs
  4. Farmiliarize yourself with Rizing's IT infrastructure and Kubernetes environments
  5. Clone a repository and review some code
  6. Explore other Developer Guide content

Non-technical new hire​

  1. Review Rizing's Company overview
  2. Farmiliarize yourself with Rizing's IT infrastructure
  3. Review Rizing's Products Overview and Soc 2 Compliance docs
  4. Farmiliarize yourself with Azure DevOps usage at Rizing and Project Operations
  5. Explore General Docs

Non-developer that wants to contribute to Developer Guide docs​

  1. Review the Markdown docs
  2. Review the Contributing section

✏ī¸ Contributing​

Overview​

Product documentation is maintained using Markdown within an open source documentation application called Docusaurus. This is the standard mechanism for all product documentation within Rizing.

RECOMMENDATION

Familiarize yourself with Docusaurus and Rizing's documentation style guide before getting started.


See the Product Documentation section for details on setting up your environment to contribute to documentation.

Quick Start​

If your environment is already setup:

git clone https://rizing-devops@dev.azure.com/rizing-devops/rizing/_git/monorepo
cd monorepo
npm install
tip

See Cloning a Repository docs for help on cloning a repository for the first time in ADO.

Run docs​

npm run start:dev-guide:docs