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

Add documenation to README.md and RELEASING.md #4

Merged
merged 2 commits into from
Dec 14, 2021

Conversation

pichlermarc
Copy link
Member

This PR adds

  • a basic repository description to README.md
  • a description where to find the published releases to README.md
  • a description of the release process to RELEASING.md

@pichlermarc
Copy link
Member Author

Please note that the failing PR build is unrelated as this PR only changes Markdown files.

@jkwatson
Copy link

something is definitely messed up with the PR build. It's trying to download an unreleased version of the proto zip....

README.md Outdated Show resolved Hide resolved

```groovy
implementation 'io.opentelemetry.proto:opentelemetry-proto:{{version}}'
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the help! Yeah the build fails until a new release of the proto has been made upstream, due to a shortcut to make the release as simple as possible. Will look into improving it

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you for pointing this out. :)
I just wanted to mention it in this PR as it has no effect on the build. Should I create an issue for that in the meantime?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure :)

@anuraaga anuraaga merged commit efeeaf1 into open-telemetry:main Dec 14, 2021
@pichlermarc pichlermarc deleted the add-documentation branch December 14, 2021 09:05
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.

3 participants