From a4ee1e98b1bb938113e2a49344985d9458a79197 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 22 Apr 2020 12:57:50 -0400 Subject: [PATCH] Use YAML for site config (#207) When there is lots of nested data it is easier, IMHO, to work with YAML than TOML. This makes the switch for the main site config file. I've ensure that exactly the same site is generated before and after this change. --- config.toml | 210 ---------------------------------------------------- config.yaml | 166 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 166 insertions(+), 210 deletions(-) delete mode 100644 config.toml create mode 100644 config.yaml diff --git a/config.toml b/config.toml deleted file mode 100644 index ae01952..0000000 --- a/config.toml +++ /dev/null @@ -1,210 +0,0 @@ -baseURL = "https://grpc.io/" -languageCode = "en-us" -title = "gRPC" -pygmentsCodeFences = true -disableKinds = ["taxonomy", "taxonomyTerm"] - -[markup.goldmark.renderer] -unsafe = true - -[markup.highlight] -style = "manni" - -[params] -locale = "en_US" -grpc_release_tag = "v1.28.1" -grpc_release_tag_no_v = "1.28.1" -grpc_java_release_tag = "v1.29.0" -google_analytics_id = "UA-60127042-1" -font_awesome_version = "5.12.1" - -milestones_link = "https://github.com/grpc/grpc/milestones" -description = "A high-performance, open source universal RPC framework" -why = """ -gRPC is a modern open source high performance RPC framework that can run in any environment. It can efficiently connect services in and across data centers with pluggable support for load balancing, tracing, health checking and authentication. It is also applicable in last mile of distributed computing to connect devices, mobile applications and browsers to backend services. -""" - -[params.social] -twitter = "https://twitter.com/grpcio" -gitter = "https://gitter.im/grpc/grpc" -reddit = "https://www.reddit.com/r/grpc" -twitter_handle = "@grpcio" - -[[params.features]] -title = "Simple service definition" -description = "Define your service using Protocol Buffers, a powerful binary serialization toolset and language" -icon = "feature-1.svg" - -[[params.features]] -title = "Start quickly and scale" -description = "Install runtime and dev environments with a single line and also scale to millions of RPCs per second with the framework" -icon = "feature-2.svg" - -[[params.features]] -title = "Works across languages and platforms" -description = "Automatically generate idiomatic client and server stubs for your service in a variety of languages and platforms" -icon = "feature-3.svg" - -[[params.features]] -title = "Bi-directional streaming and integrated auth" -description = "Bi-directional streaming and fully integrated pluggable authentication with HTTP/2-based transport" -icon = "feature-4.svg" - - -[params.logos] -navbar = "grpc-horizontal-white.png" -hero = "grpc-logo.png" -footer = "grpc-horizontal-white.png" - -# Configuration required for auto-generating the Netlify _redirects file -[mediaTypes."text/netlify"] -delimiter = "" - -[outputFormats.REDIRECTS] -mediaType = "text/netlify" -baseName = "_redirects" - -[outputFormats.RSS] -baseName = "feed" - -[outputFormats.RELEASE] -baseName = "release" - -[outputs] -home = ["HTML", "REDIRECTS", "RSS", "RELEASE"] - -[[params.fonts]] -name = "Open Sans" -sizes = [300, 400, 600, 700] -type = "sans_serif" - -# Site menus -[[menu.main]] -name = "About" -url = "/about" -weight = 1 - -[[menu.main]] -name = "Docs" -url = "/docs" -identifier = "docs" -weight = 2 - -[[menu.main]] -name = "Guides" -url = "/docs/guides" -identifier = "guides" -weight = 3 - -[[menu.main]] -name = "Blog" -url = "/blog" -weight = 4 - -[[menu.main]] -name = "Community" -url = "/community" -weight = 5 - -[[menu.main]] -name = "Packages" -url = "https://packages.grpc.io" -weight = 6 - -[[menu.main]] -name = "Overview" -url = "/docs" -weight = 1 -parent = "docs" - -[[menu.main]] -name = "Quick Start" -url = "/docs/quickstart/" -weight = 2 -parent = "docs" - -[[menu.main]] -name = "Tutorials" -url = "/docs/tutorials/" -weight = 3 -parent = "docs" - -[[menu.main]] -name = "Reference" -url = "/docs/reference/" -weight = 4 -parent = "docs" - -[[menu.main]] -name = "Samples" -url = "/docs/samples/" -weight = 5 -parent = "docs" - -[[menu.main]] -name = "Presentations" -url = "/docs/talks/" -weight = 6 -parent = "docs" - -[[menu.main]] -name = "FAQ" -url = "/faq" -weight = 7 -parent = "docs" - -[[menu.main]] -name = "What is gRPC?" -url = "/docs/guides/" -weight = 1 -parent = "guides" - -[[menu.main]] -name = "gRPC Concepts" -url = "/docs/guides/concepts/" -weight = 2 -parent = "guides" - -[[menu.main]] -name = "Authentication" -url = "/docs/guides/auth/" -weight = 3 -parent = "guides" - -[[menu.main]] -name = "Error handling and debugging" -url = "/docs/guides/error/" -weight = 4 -parent = "guides" - -[[menu.main]] -name = "Benchmarking" -url = "/docs/guides/benchmarking/" -weight = 5 -parent = "guides" - -[[menu.main]] -name = "gRPC Wire Format" -url = "https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md" -weight = 6 -parent = "guides" - -[[menu.buttons]] -name = "Quick Start" -url = "/docs/quickstart" -weight = 1 - -[[menu.buttons]] -name = "Docs" -url = "/docs" -weight = 2 - -[[menu.buttons]] -name = "Concepts" -url = "/docs/guides/concepts" -weight = 3 - -[[menu.buttons]] -name = "Community" -url = "/community" -weight = 4 diff --git a/config.yaml b/config.yaml new file mode 100644 index 0000000..b0b4e25 --- /dev/null +++ b/config.yaml @@ -0,0 +1,166 @@ +baseURL: https://grpc.io/ +languageCode: en-us +title: gRPC +disableKinds: [taxonomy, taxonomyTerm] +pygmentsCodeFences: true + +params: + locale: en_US + grpc_release_tag: v1.28.1 + grpc_release_tag_no_v: 1.28.1 + grpc_java_release_tag: v1.29.0 + google_analytics_id: UA-60127042-1 + font_awesome_version: 5.12.1 + milestones_link: https://github.com/grpc/grpc/milestones + description: A high-performance, open source universal RPC framework + why: > + gRPC is a modern open source high performance RPC framework that can run in + any environment. It can efficiently connect services in and across data + centers with pluggable support for load balancing, tracing, health checking + and authentication. It is also applicable in last mile of distributed + computing to connect devices, mobile applications and browsers to backend + services. + + social: + twitter: https://twitter.com/grpcio + gitter: https://gitter.im/grpc/grpc + reddit: https://www.reddit.com/r/grpc + twitter_handle: '@grpcio' + + features: + - title: Simple service definition + description: Define your service using Protocol Buffers, a powerful binary serialization toolset and language + icon: feature-1.svg + - title: Start quickly and scale + description: Install runtime and dev environments with a single line and also scale to millions of RPCs per second with the framework + icon: feature-2.svg + - title: Works across languages and platforms + description: Automatically generate idiomatic client and server stubs for your service in a variety of languages and platforms + icon: feature-3.svg + - title: Bi-directional streaming and integrated auth + description: Bi-directional streaming and fully integrated pluggable authentication with HTTP/2-based transport + icon: feature-4.svg + + fonts: + - name: 'Open Sans' + sizes: [300, 400, 600, 700] + type: sans_serif + + logos: + navbar: grpc-horizontal-white.png + hero: grpc-logo.png + footer: grpc-horizontal-white.png + +markup: + goldmark: + renderer: {unsafe: true} + highlight: + style: manni + +# Configuration required for auto-generating the Netlify _redirects file +mediaTypes: + text/netlify: + delimiter: '' + +outputFormats: + REDIRECTS: + mediaType: text/netlify + baseName: _redirects + RSS: + baseName: feed + RELEASE: + baseName: release + +outputs: + home: [HTML, REDIRECTS, RSS, RELEASE] + +# Site menus + +menu: + main: + - name: About + url: /about + weight: 1 + - name: Docs + url: /docs + identifier: docs + weight: 2 + - name: Guides + url: /docs/guides + identifier: guides + weight: 3 + - name: Blog + url: /blog + weight: 4 + - name: Community + url: /community + weight: 5 + - name: Packages + url: https://packages.grpc.io + weight: 6 + - name: Overview + url: /docs + weight: 1 + parent: docs + - name: Quick Start + url: /docs/quickstart/ + weight: 2 + parent: docs + - name: Tutorials + url: /docs/tutorials/ + weight: 3 + parent: docs + - name: Reference + url: /docs/reference/ + weight: 4 + parent: docs + - name: Samples + url: /docs/samples/ + weight: 5 + parent: docs + - name: Presentations + url: /docs/talks/ + weight: 6 + parent: docs + - name: FAQ + url: /faq + weight: 7 + parent: docs + - name: What is gRPC? + url: /docs/guides/ + weight: 1 + parent: guides + - name: gRPC Concepts + url: /docs/guides/concepts/ + weight: 2 + parent: guides + - name: Authentication + url: /docs/guides/auth/ + weight: 3 + parent: guides + - name: Error handling and debugging + url: /docs/guides/error/ + weight: 4 + parent: guides + - name: Benchmarking + url: /docs/guides/benchmarking/ + weight: 5 + parent: guides + - name: gRPC Wire Format + url: https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md + weight: 6 + parent: guides + + buttons: + - name: Quick Start + url: /docs/quickstart + weight: 1 + - name: Docs + url: /docs + weight: 2 + - name: Concepts + url: /docs/guides/concepts + weight: 3 + - name: Community + url: /community + weight: 4