Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposed Taxonomy tree #46

Merged
merged 2 commits into from
May 20, 2024
Merged

Proposed Taxonomy tree #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50ef474
Proposed Taxonomy tree
jjasghar May 13, 2024
e2f9308
Update docs/taxonomy-tree-organization.md
jjasghar May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/taxonomy-tree-organization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Taxonomy Tree Organization

This document describes the justification and decision to choose
to emulate the [Wikipedia taxonomy](https://en.wikipedia.org/wiki/Wikipedia:Contents) structure for our `knowledge/` tree in the taxonomy repository.

The definition of taxonomy from Wikipedia:
> A taxonomy is a scheme of classification, especially a hierarchical classification, in which things are organized into groups or types. Among other things, a taxonomy can be used to organize and index knowledge (stored as documents, articles, videos, etc.), such as in the form of a library classification system, or a search engine taxonomy, so that users can more easily find the information they are searching for. Many taxonomies are hierarchies (and thus, have an intrinsic tree structure), but not all are.

## Why do we need this?

Our taxonomy tree is not only how humans will place
the different `qna.yaml`s, but it's how people will look for
and update changes for specific questions and answers.
Having the challenge of this organization, copying Wikipedia's
tree is a good default standard.

## What are we going to do to enforce this?

The triage team will take into consideration the location of the
directory and how it pertains to the suggested tree that Wikipedia
publishes their as. The merging of [this PR](https://github.com/instructlab/taxonomy/pull/780)
will build the initial tree, which we can work with the backend
team to solidify the tree going forward.
Creating a new "top level" directory will require understanding
that it will be a special rare case, while lower left nodes of
the tree as long as they are put in logical place is empowered
by the contributor.
The side effect leveraging using this we can verify where the
knowledge is placed on Wikipedia and reinforce the location
in the taxonomy tree.

## Conflicts and Resolutions

With adopting this format and structure there will be conflicts and debate
about the placement of the `qna.yaml`. The triage team will do their best
to take into consideration of the challenges that may arise, and work
with the contributor to hear and engage with that conflict. The triage
team has the ultimate decision on the location of the directory and
file.