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

Docs update #1557

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Docs update #1557

wants to merge 18 commits into from

Conversation

dovzhikova
Copy link
Contributor

No description provided.


This guide is perfect for you if:
Copy link
Collaborator

Choose a reason for hiding this comment

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

"This guide" is only for the "Prerequisites" page, right?
As this will be the first page of the "quickstart", I think many people might think that this refer to the quickstart itself and might skip it

Comment on lines +8 to +10
* You're new to tech tools but curious about ways to understand how your computer systems work. Maybe you've heard about "observability" and want to see what it's all about, without getting lost in technical jargon.
* You're a software developer or work in IT, and while you're comfortable with computers, you're new to Odigos. You're looking for a clear, step-by-step guide that doesn't assume you're already an expert.
* You're simply interested in Odigos and want to give it a try. This guide will walk you through the process without assuming any prior knowledge.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think most of the people that will read our docs do not belong to these categories
should we suggest them to jump to the next step without needing to read all this text?


i. After the installation is complete, close the Terminal window by clicking the red circle in the top left corner.

k. Open a new Terminal window (repeat step a) to ensure the installation takes effect.
Copy link
Collaborator

Choose a reason for hiding this comment

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

as brew is not in the system PATH, I think this is not expected to work.

The brew installation script will add instructions on how to add it to PATH at the end of the script

Comment on lines +84 to +86
d. When Docker starts for the first time, you may see a box asking for your computer's password. Enter your password and click `OK`.

e. You may see a welcome screen or tutorial from Docker. You can close this or click through it.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it might request to create an account and login when it's the first time


c. Wait for the installation to complete. You'll know it's done when you see the command prompt again.

### Installing Odigos
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is under quickstart/prerequisites but these steps are covered in the next pages.

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.

2 participants