From bc873536f35e490a1c3d044182ecaf96dc781d3c Mon Sep 17 00:00:00 2001 From: tonihei Date: Mon, 13 Mar 2023 16:34:00 +0000 Subject: [PATCH] Update docs and READMEs for media3 stable release - The ExoPlayer docs will link to the media3 ones (for now, we can permanently redirect once no further stand-alone ExoPlayer release is published). - Contibuting issues and PRs should only happen on the media3 repo. - The media3 README is updated to remove any pre-release status information. PiperOrigin-RevId: 516234594 --- CONTRIBUTING.md | 6 ++---- README.md | 37 ++++++++++++++++++------------------- 2 files changed, 20 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18b494425a..87bf328019 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,12 +5,10 @@ We use the [AndroidX Media issue tracker][] to track bugs, feature requests and questions. -We are still handling ExoPlayer issues on the [ExoPlayer GitHub issue tracker][] -while the ExoPlayer and AndroidX Media projects coexist. - Before filing a new issue, please search the trackers to check if it's already covered by an existing report. Avoiding duplicates helps us maximize the time we -can spend fixing bugs and adding new features. +can spend fixing bugs and adding new features. You will also find older issues +on our [ExoPlayer GitHub issue tracker][]. When filing an issue, be sure to provide enough information for us to efficiently diagnose and reproduce the problem. In particular, please include diff --git a/README.md b/README.md index d0b375b92d..39a1e3e868 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,27 @@ AndroidX Media is a collection of libraries for implementing media use cases on Android, including local playback (via ExoPlayer) and media sessions. -## Current status +## Documentation -AndroidX Media is currently in release candidate and we welcome your feedback -via the [issue tracker][]. Please consult the [release notes][] for more details -about the current release. +* The [developer guide][] provides a wealth of information. +* The [class reference][] documents the classes and methods. +* The [release notes][] document the major changes in each release. +* Follow our [developer blog][] to keep up to date with the latest + developments! -ExoPlayer's new home will be in AndroidX Media, but for now we are publishing it -both in AndroidX Media and via the existing [ExoPlayer project][] and we are -still handling ExoPlayer issues on the [ExoPlayer issue tracker][]. +[developer guide]: https://developer.android.com/guide/topics/media/media3 +[class reference]: https://developer.android.com/reference/androidx/media3/common/package-summary +[release notes]: RELEASENOTES.md +[developer blog]: https://medium.com/google-exoplayer -You'll find some [Media3 documentation on developer.android.com][], including a -[migration guide for existing ExoPlayer and MediaSession users][]. +## Migration for existing ExoPlayer and MediaSession projects + +You'll find a [migration guide for existing ExoPlayer and MediaSession users][] +on developer.android.com. + +[migration guide for existing ExoPlayer and MediaSession users]: https://developer.android.com/guide/topics/media/media3/getting-started/migration-guide + +## API stability AndroidX Media releases provide API stability guarantees, ensuring that the API surface remains backwards compatible for the most commonly used APIs. APIs @@ -22,17 +31,7 @@ intended for more advanced use cases are marked as unstable. To use an unstable method or class without lint warnings, you’ll need to add the OptIn annotation before using it. For more information see the [UnstableApi][] documentation. -For a high level overview of the initial version of AndroidX Media please see -the Android Dev Summit talk [What's next for AndroidX Media and ExoPlayer][]. - -[release notes]: RELEASENOTES.md -[issue tracker]: https://github.com/androidx/media/issues/new -[ExoPlayer project]: https://github.com/google/ExoPlayer -[ExoPlayer issue tracker]: https://github.com/google/ExoPlayer/issues [UnstableApi]: https://github.com/androidx/media/blob/main/libraries/common/src/main/java/androidx/media3/common/util/UnstableApi.java -[What's next for AndroidX Media and ExoPlayer]: https://youtu.be/sTIBDcyCmCg -[Media3 documentation on developer.android.com]: https://developer.android.com/guide/topics/media/media3 -[migration guide for existing ExoPlayer and MediaSession users]: https://developer.android.com/guide/topics/media/media3/getting-started/migration-guide ## Using the libraries