Add website docs for metadata functions -json command
#32701
Conversation
|
Marking this as a draft for now, as I figure out why the Vercel deployment failed |
dbanck
force-pushed
the
docs-metadata-functions
branch
from
c02e5c3 to
9c98d66
Compare
|
Deployment works now, page is accessible here: https://terraform-fm6jhtxlj-hashicorp.vercel.app/terraform/internals/functions-meta |
website/data/internals-nav-data.json
Outdated
| "title": "Metadata Functions", | ||
| "path": "metadata-functions" |
There was a problem hiding this comment.
| "title": "Metadata Functions", | |
| "path": "metadata-functions" | |
| "title": "Functions Metadata", | |
| "path": "functions-meta" |
Would it make sense to align this more with the item above?
There was a problem hiding this comment.
I'm still not sure it needs to be in the sidebar on such a prominent position - but I'd leave the Core team to comment on that.
There was a problem hiding this comment.
Oh I see now it's under Internals - ignore my last note then! 😄
There was a problem hiding this comment.
I was following the naming pattern for the docs of other commands, but since this now lives under internals, we could rename it.
There was a problem hiding this comment.
I'd agree that "Functions Metadata" is clearer now that we're out of the context where repeating the command name is useful.
|
|
||
| ```javascript | ||
| { | ||
| // "name" is the internal name of the parameter |
There was a problem hiding this comment.
| // "name" is the internal name of the parameter | |
| // "name" is the internal name of the parameter |
| ## 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 //. |
There was a problem hiding this comment.
| Important elements are described with comments, which are prefixed with //. | |
| Important elements are described with comments, which are prefixed with `//`. |
| "description": "string", | ||
|
|
||
| // "type" is a representation of a type specification | ||
| // that the parameters's value must conform to. |
There was a problem hiding this comment.
| // that the parameters's value must conform to. | |
| // that the parameter's value must conform to. |
|
These docs look good to me, aside from the handful of typos! |
* Renamed the doc * Fixed small typos
alisdair
added
the
1.4-backport
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
This PR is a follow up to #32487 and adds documentation for the new command.
Fixes #32682
Target Release
1.4.x
Open Questions
Accessing Metadata. Does that make sense? Should we rename it or move it somewhere else? --> moved tointernals/