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.

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

Create an architecture document #6

Closed
jodh-intel opened this issue Dec 21, 2017 · 2 comments
Closed

Create an architecture document #6

jodh-intel opened this issue Dec 21, 2017 · 2 comments

Comments

@jodh-intel
Copy link
Contributor

We need to create an ARCHITECTURE.md that covers the overall system.

This document could, if necessary, reference architecture documents found in each components repository. These would essentially document just themselves. The intent is to define once and reference as many times as needed.

For example, the ARCHITECTURE.md created in this repository may say something like:

For further details on the Kata shim implementation, refer to the shim architecture document

Component repositories

The individual README.md files in each code repository must contain a reference to this central architecture document.

If a component repository has a separate ARCHITECTURE.md this:

  • Must be referenced in the components README.md.
  • Must itself reference the central ARCHITECTURE.md document.

For an example of what we should be aiming for, see the Clear Containers architecture document:

Diagrams

All diagrams must:

  • Be stored along with their corresponding "source" files (for example, if a .png file is referenced, the .svg file that was used to generate the .png must also be stored to allow the diagrams to be updated by all.
  • Use freely available open formats for their sources.
@jodh-intel
Copy link
Contributor Author

jodh-intel commented Dec 21, 2017

I forgot to add, the ideal would probably be to start hosting all the technical documentation in a new repository. Something like https://github.com/kata-containers/documentation.

/cc @kata-containers/documentation, @sameo, @gnawux, @grahamwhaley, @klynnrif.

@jodh-intel
Copy link
Contributor Author

Moved to kata-containers/documentation#1 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant