From 837b88ce8980a5d7a83a5618ab9a73a2ea0c9737 Mon Sep 17 00:00:00 2001 From: Daniel Banck Date: Fri, 17 Feb 2023 16:35:23 +0100 Subject: [PATCH] Review feedback * Renamed the doc * Fixed small typos --- website/data/internals-nav-data.json | 4 ++-- .../{metadata-functions.mdx => functions-meta.mdx} | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) rename website/docs/internals/{metadata-functions.mdx => functions-meta.mdx} (95%) diff --git a/website/data/internals-nav-data.json b/website/data/internals-nav-data.json index f676abb2e1ff..025ac6a4e155 100644 --- a/website/data/internals-nav-data.json +++ b/website/data/internals-nav-data.json @@ -45,8 +45,8 @@ "path": "provider-meta" }, { - "title": "Metadata Functions", - "path": "metadata-functions" + "title": "Functions Metadata", + "path": "functions-meta" }, { "title": "Machine Readable UI", diff --git a/website/docs/internals/metadata-functions.mdx b/website/docs/internals/functions-meta.mdx similarity index 95% rename from website/docs/internals/metadata-functions.mdx rename to website/docs/internals/functions-meta.mdx index 39ee05946c3b..6444f49fd62e 100644 --- a/website/docs/internals/metadata-functions.mdx +++ b/website/docs/internals/functions-meta.mdx @@ -1,5 +1,5 @@ --- -page_title: 'Command: metadata functions' +page_title: Functions Metadata description: >- The `terraform metadata functions` command prints signatures for all the functions available in the current Terraform version. @@ -37,7 +37,7 @@ We will introduce new major versions only within the bounds of ## Format Summary The following sections describe the JSON output format by example, using a pseudo-JSON notation. -Important elements are described with comments, which are prefixed with //. +Important elements are described with comments, which are prefixed with `//`. To avoid excessive repetition, we've split the complete format into several discrete sub-objects, described under separate headers. References wrapped in angle brackets (like ``) are placeholders which, in the real output, would be replaced by an instance of the specified sub-object. The JSON output format consists of the following objects and sub-objects: @@ -87,7 +87,7 @@ A parameter representation describes a parameter to a function. ```javascript { - // "name" is the internal name of the parameter + // "name" is the internal name of the parameter "name": "string", // "description" is an optional English-language description of @@ -95,7 +95,7 @@ A parameter representation describes a parameter to a function. "description": "string", // "type" is a representation of a type specification - // that the parameters's value must conform to. + // that the parameter's value must conform to. "type": "string" } ```