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 README and documentation to better communicate pre-GA state #1281

Merged
merged 4 commits into from
Oct 29, 2020

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Oct 27, 2020

  • Move project status to top of project documentation and add explicit warnings that this project may introduce breaking changes.
  • Use explicit warning in README about this project being pre-GA.
  • Add disclaimer to package documentation.

Resolves #1279

Move project status to top of project documentation and add explicit
warnings that this project may introduce breaking changes.
@MrAlias MrAlias added documentation Provides helpful information Skip Changelog PRs that do not require a CHANGELOG.md entry labels Oct 27, 2020
@MrAlias MrAlias self-assigned this Oct 27, 2020
README.md Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 29, 2020

Codecov Report

Merging #1281 into master will increase coverage by 0.0%.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1281   +/-   ##
======================================
  Coverage    76.8%   76.8%           
======================================
  Files         122     122           
  Lines        5953    5944    -9     
======================================
- Hits         4574    4568    -6     
+ Misses       1131    1129    -2     
+ Partials      248     247    -1     
Impacted Files Coverage Δ
codes/codes.go 100.0% <ø> (+10.3%) ⬆️
sdk/opentelemetry.go 100.0% <ø> (ø)

@MrAlias MrAlias merged commit 0341956 into open-telemetry:master Oct 29, 2020
@MrAlias MrAlias deleted the update-README branch October 29, 2020 16:23
AzfaarQureshi pushed a commit to open-o11y/opentelemetry-go that referenced this pull request Dec 3, 2020
…pen-telemetry#1281)

* Update README

Move project status to top of project documentation and add explicit
warnings that this project may introduce breaking changes.

* Add disclaimer to public packages docs

* Use explicit warning in README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Provides helpful information Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README and documentation to better communicate pre-GA state
5 participants