Skip to content

Home

This is the official source of all one-connect technical documentation. It is generated from oc-docs and supplemented from other repositories docs folders.

Big Picture covers the high level guidance and principles. Please work with Stuart Miller (ATLs cloud arch)

Platform encompasses the cloud provider setup (Infrastructure) oc-infrastructure, the one connect kubernetes manifests (Applications) argocd-oc-apps and system (System) argocd-oc-system that bootstraps ArgoCD.

Components Documents all images that form part of oneConnect, including the published API schemas. The text for each of these should briefly describe the image properties and role. The behavioral details should be comprehensively documented via the cluster tests and the schemas instead. Any information that is generally true over many images doesn't belong here, that can be captured in workflows, code libraries and the example service code. The documentation comes from the image repositories

Workflows encompasses all the 'how to's for development, testing and documentation. This is stored in oc-docs. Anyone can update these without need of review. A simple way is to click the link at top of page to edit which should open it within github dev online VCS editor.

Roadmap Capturing broad technical decisions and plans for future technical/process changes. These should not duplicate jira work, but used as notes on distant obstacles to later form specific Jira items. Can click the link at top of page to edit which should open it within github dev online VCS editor.

Management covers information relevant to management, like which teams are involved in the solution, our development and testing process, which JIRA backlogs we use, project impediments.

Audience

The Big Picture section will be useful to both developers and non-developers. The remaining sections are aimed at the both the development teams and the platform team. Please keep these audiences in mind when writing documentation.

How to keep up-to-date

If you setup a watch on the oc-docs repository, you will get notifications of any changes to the documentation. Changes to image documentation won't be captured as they are in gerrit repos, and it's still encouraged to engage with teams in teams channels to communicate changes or intended changes.