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
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
4020856
task: update documentation
o11yguru Feb 22, 2024
7e927c1
task: remove old src folder
o11yguru Feb 22, 2024
84a95fa
task: update doucmentation with ingresss install guide
o11yguru Feb 29, 2024
6f70094
task: update doucmentation aws install steps
o11yguru Feb 29, 2024
e4c85f7
task: updating ingress
o11yguru Mar 1, 2024
f047f4a
add toc, validate data flow and console screenshots
weird-bytecode Mar 1, 2024
369680f
little formatting cleanups, 🐙🎉
weird-bytecode Mar 1, 2024
0d0e9d6
task: update more docs
o11yguru Mar 2, 2024
2aecccc
Merge branch 'documentation-updates' into wb/validate-data-flow
weird-bytecode Mar 2, 2024
84926e7
Merge pull request #4 from DecisiveAI/wb/validate-data-flow
weird-bytecode Mar 2, 2024
ebabbab
update AWS install
o11ies Mar 4, 2024
cc52dac
task: updating doc sections
o11yguru Mar 4, 2024
a21fef6
tiny update
o11ies Mar 4, 2024
cd3a4c7
rename
o11ies Mar 4, 2024
a269ed4
one more
o11ies Mar 4, 2024
b123c9c
task: updating doc sections
o11yguru Mar 4, 2024
2c98dac
task: updates for joe
o11yguru Mar 4, 2024
c9df718
update otel pre configuration
o11ies Mar 4, 2024
6678e2a
add console page
weird-bytecode Mar 5, 2024
6237f7a
add google analytics
o11ies Mar 5, 2024
7219426
task: updating docs in a more chapter-friendly way
o11yguru Mar 7, 2024
018fc89
fix: post-demo doc updates
o11yguru Mar 8, 2024
ce44a72
Update SUMMARY.md
zoomzoomsheim Mar 8, 2024
d82f7ea
Update mdai-console.md
zoomzoomsheim Mar 8, 2024
10f66c0
Update mdai-console.md
zoomzoomsheim Mar 8, 2024
9caf104
Update mdai-console.md
zoomzoomsheim Mar 8, 2024
c20acbc
update for the local installation script
o11ies Mar 8, 2024
5b6330b
add context switch step for local unistall
o11ies Mar 8, 2024
fcac36a
make it a note
o11ies Mar 8, 2024
1477976
Update start.md
checosodecisive Mar 8, 2024
2b4629a
Update start.md
checosodecisive Mar 8, 2024
aca8855
Update prerequisites.md
checosodecisive Mar 8, 2024
469a22e
Update prerequisites.md
checosodecisive Mar 8, 2024
f1c4094
Update aws-sso.md
checosodecisive Mar 8, 2024
9de820f
Update configure.md
checosodecisive Mar 8, 2024
0792ce1
Update installation.md
checosodecisive Mar 9, 2024
48565b6
Update installation.md
checosodecisive Mar 9, 2024
5cc66a8
Update start.md
checosodecisive Mar 9, 2024
274e141
Update SUMMARY.md
checosodecisive Mar 9, 2024
7be046e
Update deploy.md
checosodecisive Mar 9, 2024
4a24e40
Update deploy.md
checosodecisive Mar 9, 2024
6281d33
Update ingress.md
checosodecisive Mar 9, 2024
985cc29
Update verify.md
checosodecisive Mar 9, 2024
0391a17
Update SUMMARY.md
checosodecisive Mar 9, 2024
2411c91
Update verify.md
checosodecisive Mar 9, 2024
4a2a8f6
Update generate-telemetry.md
checosodecisive Mar 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion book.toml
@@ -1,5 +1,5 @@
[book]
authors = ["weird-bytecode"]
authors = ["DecisiveAI, Inc."]
language = "en"
multilingual = false
src = "src"
Expand Down
10 changes: 0 additions & 10 deletions src/GettingStarted.md

This file was deleted.

18 changes: 18 additions & 0 deletions src/JILL_ALL_DOCS.md
@@ -0,0 +1,18 @@
---
title: Documentation
linkTitle: Docs
menu: { main: { weight: 10 } }
---

MyDecisive.ai, also known as MDAI, is an Open-source framework
for instrumenting, generating, collecting, and exporting telemetry data such as
[traces](/docs/concepts/signals/traces/),
[metrics](/docs/concepts/signals/metrics/), and
[logs](/docs/concepts/signals/logs/).

As an industry-standard, OpenTelemetry is
[supported by more than 40 observability vendors](/ecosystem/vendors/),
integrated by many [libraries, services, and apps](/ecosystem/integrations), and
adopted by [numerous end users](/ecosystem/adopters).

![OpenTelemetry Reference Architecture](/img/otel-diagram.svg)
7 changes: 0 additions & 7 deletions src/Operation/config.md

This file was deleted.

67 changes: 65 additions & 2 deletions src/SUMMARY.md
@@ -1,11 +1,74 @@
# Summary
# MyDecisive (MDAI) Engine©

[Introduction](./intro.md)
- [Introduction]()
- [Overview](./intro/overview.md)
- [The MDAI Engine©](./intro/intro.md)
- [Expectations](./intro/expectations.md)

- [Installation]()
- [Installing the MDAI Engine©](./install/installation.md)
- [Quick Start](./install/quick-start.md)
- [MDAI Engine© in AWS](./install/aws.md)

<!--
# Usage Guide

- [Installation](./install/install.md)
- [To an existing k8s cluster](./install/k8s-helm.md)
- [To a new AWS EKS cluster](./install/k8s-cdk.md)
- [Configuration](./Operation/config.md)
- [Troubleshooting](./troubleshooting.md)



#### Collector requirements

#### Sizing and Scaling


#### Processor Architecture



### Configure
### Install

- Installation instructions for deploying EKS locally or on-premises
- Setup instructions for OpenTelemetry and Prometheus components
- Basic configuration steps

-----------------------------------------------------------------------

## Contributing
- Guidelines for contributing code, documentation, or bug fixes
- Code repository location (e.g., GitHub)
- Contribution guidelines and code review process

## Community Engagement
- Links to community forums, mailing lists, or chat channels
- How to get support (e.g., FAQs, support tickets)
- Opportunities for community involvement

## Risk and Disclaimers
- Potential risks associated with using pre-alpha software
- Disclaimer about stability, data loss, and other issues
- Recommended backup and recovery procedures

## Legal and Licensing
- License information for the pre-alpha release
- Copyright notices and third-party dependencies
- Terms of use for early adopters

## Future Development
- Planned features and improvements for upcoming releases
- Roadmap for transitioning from pre-alpha to alpha/beta stages
- Community feedback integration process

## Glossary
- Definitions of technical terms and acronyms used in the documentation

## Appendices
- Additional resources for testers and contributors
- Release notes for the pre-alpha version
- Frequently Asked Questions (FAQs) specific to the pre-alpha release
-->
4 changes: 4 additions & 0 deletions src/architecture-overview.md
@@ -0,0 +1,4 @@
## Architecture Overview
- Overview of the system architecture with EKS, OpenTelemetry, and Prometheus
- High-level components and their interactions
- Data flow diagrams illustrating telemetry collection and monitoring processes
4 changes: 4 additions & 0 deletions src/deployment.md
@@ -0,0 +1,4 @@
## Deployment Guide
- Step-by-step instructions for deploying EKS clusters locally or on-premises
- Configuration steps for deploying OpenTelemetry components (collectors, exporters) on EKS
- Configuration steps for deploying Prometheus for self-monitoring
10 changes: 10 additions & 0 deletions src/feedback.md
@@ -0,0 +1,10 @@
## How to give the MyDecisive Team feedback

### General Feedback
TODO

### Bug Reports
TODO

### Feature Requests
TODO
1 change: 0 additions & 1 deletion src/images/Engineer-white.svg

This file was deleted.

1 change: 0 additions & 1 deletion src/images/Identifywhite.svg

This file was deleted.