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
task: update documentation #3
Conversation
add toc, validate data flow and console screenshots
Work in progress. figuring out styles
Copy changes made. NOTE: needs the second Sankey Diagram screenshot replaced with highlighted version (noted in CSS)
|
||
Here's a brief diagram for how we are using our preferred technologies to build our infrastructure to help the DevOps community! | ||
|
||
[![Container Diagram](../media/arch-c2.png)](../media/arch-c2.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a paragraph describing what the API is doing and what the Console does below here would be useful.
I'd also say the MyDecisiveAI octopus outside of the k8s cluster with an arrow saying "monitors" and "configures" is confusing. It could give the impression that MyDecisive is a cloud services running elsewhere monitoring your deployment.
```shell | ||
cdk destroy --profile <your_aws_profile> | ||
``` | ||
- The destroy process will run for a while and may return an error due some resources having dependencies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The destroy process will run for a while and may return an error due some resources having dependencies. | |
- The destroy process will run for a while and may return an error due to some resources having dependencies. |
|
||
- Delete the Open Telemetry Collector | ||
```shell | ||
kubectl delete otelcol/<your_collector_name> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is this name from?
``` | ||
cd mdai-inkops | ||
|
||
code mdai-inkops |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd remove any reference to a specific IDE. I assume this is VSCode?
Documentation updates for March release