From 281e5ceffbeb646dd39571cd8111246fa3d68a53 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 3 Nov 2020 08:43:43 -0500 Subject: [PATCH] Move Android Java pages to platforms/android/java (#489) Followup to #473, which made minimal changes -- it _only_ relocated the Android and Web pages without changing them. This PR moves the Android pages (which are Java specific) to a sublevel, like this: - /docs/ - platforms/ - android/ - **java/{quick-start, basics,...}** - kotlin/quick-start - dart or flutter ... - web/{quick-start, basics, ...} Context: https://github.com/grpc/grpc.io/pull/473#issuecomment-714048028 --- .cspell.json | 1 + content/docs/platforms/_index.md | 4 ++-- content/docs/platforms/android/_index.md | 10 ++++------ content/docs/platforms/android/java/_index.md | 10 ++++++++++ content/docs/platforms/android/{ => java}/api.md | 0 content/docs/platforms/android/{ => java}/basics.md | 0 .../docs/platforms/android/{ => java}/quickstart.md | 0 layouts/index.redirects | 4 ++-- 8 files changed, 19 insertions(+), 10 deletions(-) create mode 100644 content/docs/platforms/android/java/_index.md rename content/docs/platforms/android/{ => java}/api.md (100%) rename content/docs/platforms/android/{ => java}/basics.md (100%) rename content/docs/platforms/android/{ => java}/quickstart.md (100%) diff --git a/.cspell.json b/.cspell.json index 6823e34..b6d4e6f 100644 --- a/.cspell.json +++ b/.cspell.json @@ -24,6 +24,7 @@ "printf", "protoc", "pushback", + "relref", "RPC's", "RPCs", "runtimes", diff --git a/content/docs/platforms/_index.md b/content/docs/platforms/_index.md index dab49a5..dedfaf1 100644 --- a/content/docs/platforms/_index.md +++ b/content/docs/platforms/_index.md @@ -13,8 +13,8 @@ Each gRPC [language][] / platform has links to the following pages and more: Select a platform to get started: -- [Android Java](android/) +- [Android]({{< relref "android">}}) - iOS (coming soon) -- [Web](web/) +- [Web]({{< relref "web" >}}) [language]: {{< ref "languages" >}} diff --git a/content/docs/platforms/android/_index.md b/content/docs/platforms/android/_index.md index 9fc4a82..2baa3bf 100644 --- a/content/docs/platforms/android/_index.md +++ b/content/docs/platforms/android/_index.md @@ -1,10 +1,8 @@ --- -title: Android Java -api_path: grpc-java/javadoc +title: Android --- -These language-specific pages are available: +The following languages support client-side gRPC on Android: -- [Quick start](quickstart/) -- [Basics tutorial](basics/) -- [API reference](api/) +- [Java]({{}}) +- Kotlin (coming soon) diff --git a/content/docs/platforms/android/java/_index.md b/content/docs/platforms/android/java/_index.md new file mode 100644 index 0000000..9fc4a82 --- /dev/null +++ b/content/docs/platforms/android/java/_index.md @@ -0,0 +1,10 @@ +--- +title: Android Java +api_path: grpc-java/javadoc +--- + +These language-specific pages are available: + +- [Quick start](quickstart/) +- [Basics tutorial](basics/) +- [API reference](api/) diff --git a/content/docs/platforms/android/api.md b/content/docs/platforms/android/java/api.md similarity index 100% rename from content/docs/platforms/android/api.md rename to content/docs/platforms/android/java/api.md diff --git a/content/docs/platforms/android/basics.md b/content/docs/platforms/android/java/basics.md similarity index 100% rename from content/docs/platforms/android/basics.md rename to content/docs/platforms/android/java/basics.md diff --git a/content/docs/platforms/android/quickstart.md b/content/docs/platforms/android/java/quickstart.md similarity index 100% rename from content/docs/platforms/android/quickstart.md rename to content/docs/platforms/android/java/quickstart.md diff --git a/layouts/index.redirects b/layouts/index.redirects index 693f255..b1a6bc0 100644 --- a/layouts/index.redirects +++ b/layouts/index.redirects @@ -2,7 +2,7 @@ # Languages -> platforms redirects -/docs/languages/android/* /docs/platforms/android/:splat +/docs/languages/android/* /docs/platforms/android/java/:splat /docs/languages/web/* /docs/platforms/web/:splat # API reference docs @@ -14,7 +14,7 @@ # /docs/languages/:lang/api $api_path 301! # when $api_path starts with 'http' # /docs/languages/:lang/api https://grpc.github.io/$api_path 301! # otherwise; 'LANG' in $api_path is replaced by :lang -{{ $pages := (.Site.GetPage "/docs/platforms").Sections -}} +{{ $pages := (.Site.GetPage "/docs/platforms/android").Sections -}} {{ $pages := $pages | union (.Site.GetPage "/docs/languages").Sections -}} {{ range $pages -}} {{ $from_path := printf "/%sapi" .File.Dir -}}