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

task: update documentation #3

Merged
merged 46 commits into from Mar 13, 2024
Merged

task: update documentation #3

merged 46 commits into from Mar 13, 2024

Conversation

o11yguru
Copy link
Contributor

Documentation updates for March release

src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved
src/install/aws.md Outdated Show resolved Hide resolved

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)

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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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>

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

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?

@o11yguru o11yguru marked this pull request as ready for review March 13, 2024 15:05
@o11yguru o11yguru merged commit 13a77b3 into main Mar 13, 2024
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

Successfully merging this pull request may close these issues.

None yet

6 participants