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: improve the odigos architecture components page #2232

Merged
merged 41 commits into from
Jan 16, 2025

Conversation

blumamir
Copy link
Collaborator

No description provided.

Copy link
Contributor

@damemi damemi left a comment

Choose a reason for hiding this comment

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

Sorry for the massive review

It would be good to decide on some style guidelines for consistency. Some things I noticed here:

  • Capitalizing Odigos components and features. Things like Actions, Sources, Autoscaler, Instrumetor, Odiglet, Node Collector, etc. We should be consistent about when these are capitalized
  • On that note, using "the" before Odigos components -- do we thing things like Instrumentor should be "the Instrumentor" or just "Instrumentor"? I guess it depends on the context
  • Using "k8s"/"Kubernetes" -- the latter is more formal so I think we should stick to it as much as possible

blumamir and others added 28 commits January 15, 2025 18:46
Copy link
Contributor

@damemi damemi left a comment

Choose a reason for hiding this comment

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

lgtm, I think those last 2 sections about the "in context of..." would be good but will leave it up to you

@blumamir
Copy link
Collaborator Author

lgtm, I think those last 2 sections about the "in context of..." would be good but will leave it up to you

Thanks! will merge it and we can chat sometimes about what "pipeline" means in odigos and revisit this docs page to align

@blumamir blumamir merged commit a1313fc into odigos-io:main Jan 16, 2025
17 of 18 checks passed
@BenElferink BenElferink added the documentation Improvements or additions to documentation label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants