From 822eeb5aa7cf02a1b59cc849a5e1109d6312eefc Mon Sep 17 00:00:00 2001 From: Johannes Kron Date: Mon, 13 Mar 2023 10:51:38 +0000 Subject: [PATCH] doc: rename index.md to README.md which is displayed nicely in the git webview. BUG=webrtc:11375 No-Try: True Change-Id: I2dbe1ef0c74a0de8c5619b522fab39527e797d9c Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/210681 Reviewed-by: Mirko Bonadei Reviewed-by: Johannes Kron Commit-Queue: Johannes Kron Cr-Commit-Position: refs/heads/main@{#39545} --- docs/faq.md | 4 ++-- docs/native-code/{index.md => README.md} | 10 +++++----- docs/native-code/android/{index.md => README.md} | 4 ++-- docs/native-code/development/{index.md => README.md} | 9 +++++---- docs/native-code/development/contributing.md | 2 +- .../prerequisite-sw/{index.md => README.md} | 0 docs/native-code/ios/{index.md => README.md} | 4 ++-- docs/native-code/rtp-hdrext/{index.md => README.md} | 0 8 files changed, 17 insertions(+), 16 deletions(-) rename docs/native-code/{index.md => README.md} (87%) rename docs/native-code/android/{index.md => README.md} (97%) rename docs/native-code/development/{index.md => README.md} (97%) rename docs/native-code/development/prerequisite-sw/{index.md => README.md} (100%) rename docs/native-code/ios/{index.md => README.md} (98%) rename docs/native-code/rtp-hdrext/{index.md => README.md} (100%) diff --git a/docs/faq.md b/docs/faq.md index 439e9b3e1b..67535857d3 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -114,7 +114,7 @@ Go to [https://webrtc.googlesource.com/src][webrtc-repo-link]. We have put sample applications [here][examples-link]. -[examples-link]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/index.md#example-applications +[examples-link]: https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/development/README.md#example-applications ### Are WebRTC components subject to change? @@ -133,7 +133,7 @@ feature set. Please see [Getting Started][getting-started-link] and [Contributing bug fixes][contributing-link] for more information. -[getting-started-link]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/index.md +[getting-started-link]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/ [contributing-link]: https://webrtc.org/support/contributing diff --git a/docs/native-code/index.md b/docs/native-code/README.md similarity index 87% rename from docs/native-code/index.md rename to docs/native-code/README.md index 928af6e52e..ce530209ff 100644 --- a/docs/native-code/index.md +++ b/docs/native-code/README.md @@ -35,8 +35,8 @@ bugs found in native code. * [iOS][webrtc-ios-development] * [Experimental RTP header extensions][rtp-hdrext] -[webrtc-prerequitite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/index.md -[webrtc-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/index.md -[webtc-android-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/android/index.md -[webrtc-ios-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/ios/index.md -[rtp-hdrext]: https://webrtc.googlesource.com/src/+/main/docs/native-code/rtp-hdrext/index.md +[webrtc-prerequitite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/ +[webrtc-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/ +[webtc-android-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/android/ +[webrtc-ios-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/ios/ +[rtp-hdrext]: https://webrtc.googlesource.com/src/+/main/docs/native-code/rtp-hdrext/ diff --git a/docs/native-code/android/index.md b/docs/native-code/android/README.md similarity index 97% rename from docs/native-code/android/index.md rename to docs/native-code/android/README.md index e378cf9a99..256fa94993 100644 --- a/docs/native-code/android/index.md +++ b/docs/native-code/android/README.md @@ -150,9 +150,9 @@ If want to run Release builds instead; pass `is_debug=false` to GN (and preferably generate the projects files into a directory like `out/Release`). Then use the scripts generated in `out/Release/bin` instead. -[webrtc-prerequisite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/index.md +[webrtc-prerequisite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/ [webrtc-jni-doc]: https://webrtc.googlesource.com/src/+/main/sdk/android/README [apprtc-doc]: https://webrtc.googlesource.com/src/+/main/examples/androidapp/README [ninja]: https://ninja-build.org/ [prebuilt-libraries]: https://bintray.com/google/webrtc/google-webrtc -[webrtc-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/index.md +[webrtc-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/ diff --git a/docs/native-code/development/index.md b/docs/native-code/development/README.md similarity index 97% rename from docs/native-code/development/index.md rename to docs/native-code/development/README.md index 7bb290c7d9..8a2678e6cf 100644 --- a/docs/native-code/development/index.md +++ b/docs/native-code/development/README.md @@ -9,7 +9,7 @@ pages for build instructions and example applications specific to these mobile p First, be sure to install the [prerequisite software][webrtc-prerequisite-sw]. -[webrtc-prerequisite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/index.md +[webrtc-prerequisite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/ ## Getting the Code @@ -181,7 +181,7 @@ To browse it: [https://webrtc.googlesource.com/src/+/branch-heads/3987][m80] For more details, read Chromium's [Working with Branches][chromium-work-branches] and [Working with Release Branches][chromium-work-release-branches] pages. To find the branch corresponding to a Chrome release check the -[Chromium Dashboard][https://chromiumdash.appspot.com/branches]. +[Chromium Dashboard][chromium-dashboard]. ## Contributing Patches @@ -278,8 +278,9 @@ Target name `turnserver`. Used for unit tests. [ninja-build-rules]: https://gn.googlesource.com/gn/+/main/docs/reference.md#the-all-and-default-rules [gn]: https://gn.googlesource.com/gn/+/main/README.md [gn-doc]: https://gn.googlesource.com/gn/+/main/docs/reference.md#IDE-options -[webrtc-android-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/android/index.md -[webrtc-ios-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/ios/index.md +[webrtc-android-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/android/ +[webrtc-ios-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/ios/ +[chromium-dashboard]: https://chromiumdash.appspot.com/branches [chromium-work-branches]: https://www.chromium.org/developers/how-tos/get-the-code/working-with-branches [chromium-work-release-branches]: https://www.chromium.org/developers/how-tos/get-the-code/working-with-release-branches [depot-tools]: http://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up diff --git a/docs/native-code/development/contributing.md b/docs/native-code/development/contributing.md index 16814a0876..762e9a9c36 100644 --- a/docs/native-code/development/contributing.md +++ b/docs/native-code/development/contributing.md @@ -34,7 +34,7 @@ You must do some preparation in order to upload your first CL: You will not have to repeat the above. After all that, you’re ready to upload: -[Check out and build the code]: https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/development/index.md +[Check out and build the code]: https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/development/ [AUTHORS]: https://webrtc.googlesource.com/src/+/refs/heads/main/AUTHORS [new-password]: https://webrtc.googlesource.com/new-password [discuss-webrtc]: https://groups.google.com/forum/#!forum/discuss-webrtc diff --git a/docs/native-code/development/prerequisite-sw/index.md b/docs/native-code/development/prerequisite-sw/README.md similarity index 100% rename from docs/native-code/development/prerequisite-sw/index.md rename to docs/native-code/development/prerequisite-sw/README.md diff --git a/docs/native-code/ios/index.md b/docs/native-code/ios/README.md similarity index 98% rename from docs/native-code/ios/index.md rename to docs/native-code/ios/README.md index 307379f17f..d10fcf1022 100644 --- a/docs/native-code/ios/index.md +++ b/docs/native-code/ios/README.md @@ -179,8 +179,8 @@ For instructions on how to do this see [here][strip-arch]. [cocoapods]: https://cocoapods.org/pods/GoogleWebRTC -[webrtc-prerequisite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/index.md -[webrtc-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/index.md +[webrtc-prerequisite-sw]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/prerequisite-sw/ +[webrtc-development]: https://webrtc.googlesource.com/src/+/main/docs/native-code/development/ [framework-script]: https://webrtc.googlesource.com/src/+/main/tools_webrtc/ios/build_ios_libs.py [ninja]: https://ninja-build.org/ [gn]: https://gn.googlesource.com/gn/+/main/README.md diff --git a/docs/native-code/rtp-hdrext/index.md b/docs/native-code/rtp-hdrext/README.md similarity index 100% rename from docs/native-code/rtp-hdrext/index.md rename to docs/native-code/rtp-hdrext/README.md