Skip to content
This repository has been archived by the owner on Jan 19, 2023. It is now read-only.

Improve the documentation to include architecture and organization information #554

Open
aschiefe opened this issue Jan 21, 2020 · 2 comments
Assignees
Labels
api documentation Improvements or additions to documentation enhancement New feature or request

Comments

@aschiefe
Copy link

It would be a huge help to those who are new to the project to have enhanced documentation so that a new person, such as myself, could read through the documentation and understand the project layout and the general components without the need to reverse engineer the project.

Specifically it would be nice to see the following in no particular order:

  • Why things are organized in the way they are
  • General architecture design
  • General data flows, ie how data comes up from the k8 apis and into reportable data structures
  • A more robust octant API documentation for both the exposed APIs and internal function calls
@wwitzel3 wwitzel3 added api documentation Improvements or additions to documentation enhancement New feature or request labels Jan 22, 2020
@wwitzel3
Copy link
Contributor

wwitzel3 commented Oct 9, 2020

Once #1079 is merged we will be migrating all documentation over to the storybook site, https://reference.octant.dev

@wwitzel3 wwitzel3 removed the Epic label Oct 9, 2020
@wwitzel3 wwitzel3 added this to Incoming in Documentation Dec 15, 2020
@davidmirror-ops davidmirror-ops added this to To do in 0.23 via automation Jul 19, 2021
@wwitzel3 wwitzel3 moved this from To do to In progress in 0.23 Jul 19, 2021
@wwitzel3
Copy link
Contributor

Feel free to ping me with questions about anything in here https://github.com/wwitzel3/octant-diagrams @davidmirror-ops

@davidmirror-ops davidmirror-ops removed this from In progress in 0.23 Jul 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api documentation Improvements or additions to documentation enhancement New feature or request
Projects
Development

No branches or pull requests

4 participants