NO-JIRA: chore(docs/adr): begin recording architectural decisions made on this project with the help of adr-tools

[jiridanek]

https://adr.github.io/

• https://github.com/npryce/adr-tools

Description

$ brew install adr-tools
$ adr init docs/architecture/decisions

How Has This Been Tested?

This will be tested in production.

Merge criteria:

• The commits are squashed in a cohesive manner and have meaningful messages.
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has manually tested the changes and verified that the changes work

[jiridanek]

There's already a place for these, it's in

https://github.com/opendatahub-io/architecture-decision-records/tree/main/architecture-decision-records

and there are subdirectories for individual components there.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jstourac for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[jstourac]

There's already a place for these, it's in

https://github.com/opendatahub-io/architecture-decision-records/tree/main/architecture-decision-records

and there are subdirectories for individual components there.

My question is - why do we want to do such a thing in our separate repository instead of having this in the common place where other components have these documents themselves too?

[jiridanek]

My question is - why do we want to do such a thing in our separate repository instead of having this in the common place where other components have these documents themselves too?

We'd probably want to have a subdirectory in the shared repo. Either one subdirectory named after workbenches component of ODH, or one for notebooks and one for kubeflow-notebook-controller.

My inclination is all in one directory, named after ODH component.