Review the codebase

[OleksiyRudenko]

Targets: keep documentation across organization as DRY and KISS as only possible

[OleksiyRudenko]

To start, below is a an attempt of analysis what documents from current implementation are a good fit.

Document	Fit	Why	Maintenance cost	Improvement suggestion
chats	Good	Visitors will find all thematic open chats in a single place. Although this must be dubbed from any new course with a dedicated chat(s)	High	Have a course repo template with instructions to a course authors
github	Good	Visitors will find relevant course repos w/out browsing kottans github organization page. Courses can be clearly marked as effective, outdated or archived. Although this list must be updated whenever a new playlist is created or considered deperecated on youtube channel	High	Addition of an entry should be as easy as adding a line of text
youtube	Good	Visitors will find relevant course/videoset w/out browsing kottans youtube channel. Videos/playlists can be clearly marked as effective, outdated or archived. Although this list must be updated whenever a new course and/or submissions repo is created or considered deperecated	High	n/a
artifacts	Poor	Must be synced every time an original repo gets updated	High	Replace with a link to the dedicated repo
code-review	Good	Spans across all repos where students open PRs; Goes also beyond Kottans specific approach	Low	Add back-links from task submission repos. Have a submissions repo template with a README.md pre-populated with a proper link
contribute	50/50	Current text refers to 'this' repo. Contribution rules can be quite specific to a particular task submissions repo. Students may not expect to find the contribution docs beyond the task submissions repo	Med	Have a submissions repo template with a typical CONTRIBUTING.md, amendable by course maintainers
endorsements	50/50	This in an experimental feature	High	Remove for now. Revisit if new endorsements arrive
kottans-course-bootstrap	50/50	A good place for general guidelines. A course repo backbone is better when is a repo template	Low	Create a course repo template
ongoing-project	Poor	Is a highly volatile activity. Making a PR/commit to reflect every change is costly.	High	Keep tracking activities as issues. In fact, they are technically tickets/issues
philosophy	Good	It's an organization-wide statutory document	Low	n/a

Legend

Maintenance cost

• Low -- this document is a single and only source of truth; amendments are independent of other resources and do not occur often
• Med -- this document doesn't need to be 100% in sync with any other document in a different repo, however updates may be required every other time
• High -- this document must be updated whenever related resources are updated or created