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

Update project images #405

Merged
merged 7 commits into from
Oct 7, 2022

Conversation

julianocosta89
Copy link
Member

@julianocosta89 julianocosta89 commented Oct 6, 2022

Fixes #31 .

Changes

Updated images to reflect the current state of the project.

@julianocosta89 julianocosta89 added the documentation Improvements or additions to documentation label Oct 6, 2022
@julianocosta89 julianocosta89 self-assigned this Oct 6, 2022
@julianocosta89 julianocosta89 requested a review from a team as a code owner October 6, 2022 20:20
@reyang
Copy link
Member

reyang commented Oct 6, 2022

I have a different suggestion, although I'm not sure if that's the common practice:

Given we don't intend to make modifications on these images, I wonder if they should be kept out of the repo (so we don't need to keep these binaries in the history), and only referenced in the markdown files using some permanent links.

For example, all the images in this doc works fine without having to be part of the repo https://github.com/open-telemetry/opentelemetry-cpp/blob/79a9471f5c6462cf5d013331e91f25455f824cd2/examples/prometheus/README.md.

@cartersocha
Copy link
Contributor

I think a broken link error is coming from this doc:
https://github.com/open-telemetry/opentelemetry-demo/blob/main/docs/demo_screenshots.md

@julianocosta89
Copy link
Member Author

thx @cartersocha, I've missed that one.

@julianocosta89
Copy link
Member Author

ifferent suggestion, although I'm not sure if that's the common practice:

Given we don't intend to make modifications on these images, I wonder if they should be kept out of the repo (so we don't need to keep these binaries in the history), and only referenced in the markdown files using some permanent links.

For example, all the images in this doc works fine without having to be part of the repo

Sounds good @reyang, let me try this.

@julianocosta89
Copy link
Member Author

Added links and removed files. Thx for the suggestion @reyang!

@cartersocha cartersocha merged commit f904cf8 into open-telemetry:main Oct 7, 2022
@julianocosta89 julianocosta89 deleted the doc/improve-images branch October 7, 2022 14:38
@julianocosta89 julianocosta89 mentioned this pull request Oct 17, 2022
2 tasks
jmichalak9 pushed a commit to jmichalak9/opentelemetry-demo that referenced this pull request Mar 22, 2024
This pull request was closed.
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.

Improve the images
4 participants