Skip to content

Introduction

Overview

The Inno-Docs is the internal documatation hub for developer.

Served at URL: internal.docs.data.innotech.vn

Concept

The content category

This is the high-level structure for category content related to the documentation:

flowchart LR
  category[Content Category]

  %% Classification of category
  category --> collection[Collection]
  category --> api[API Specification]
  category --> project[Project]
  category --> technical[Technical]
  category --> handbook[Handbook]
  category --> misc[Misc]

  %% Component of each category

  %% Project
  collection --> c_datasets[Datasets]
  collection --> p_models[Model]

  %% Project
  project --> p_tech_stack[Technical Stack]
  project --> p_sad[System Architechture Design]
  project --> p_changelog[Changelog]
  project --> p_todo[TODO]
  project --> p_troubleshooting[Troubleshooting]

  %% Technical
  technical --> t_concept[Concept]
  technical --> t_adr[Architectural Decision Record]
  technical --> t_services[Tech Services]
    t_services --> gcp[Google Cloud Platform]
    t_services --> github[GitHub & Github Actions]
  technical --> t_framework[Framework]
  technical --> t_convention[Convention]
  technical --> t_compliance[Compliance]

Table of detail topics classification:

Category Topic Description
[A] Collection
Description Introduction, Coverage, Provider
Flow Flow to get, storage, interage datasets
[B] API Specification
API Data Interface Common endpoints, servers, version
Parameter design
Data contract The hub of data contract
[C] Project
System archtiechture design The design of system for specific project
Technology Stack
Repository level archtiechture
Implement strategy
Changelog of changes
The todo list
Contributors
Maintainers
Troubleshooting
[D] Technical
ADR (Architechture Decision Record) Record for decision in the architechture
Choosen framework, language, tools The reason behind, the requirements
Convention within project
Compliance applied for organization
[E] Handbook
[F] Misc
The meeting note

Language

Content in English.

Contributor

The documentation is contributed by all members of Data team.

Maintainer