Update docs and auto gen so it is consistent with product docs #37
Conversation
…nsistent descriptions
There was a problem hiding this comment.
Looks really good. I didn't mark all of them, but there are some code blocks that use `` directly rather than using the mdCodeOrBold template, so can we update those.
So that we stick to the conventions you are adding here, do you think you can add a docs/command_documentation.md that outlines the guidance you are putting into place here.
internal/pkg/cmd/gen_md.go
Outdated
| fmt.Fprintf(buf, "- `-%s, %s` -", flag.Shorthand, longDisplay) | ||
| } else { | ||
| fmt.Fprintf(buf, "`%s`\n\n", longDisplay) | ||
| fmt.Fprintf(buf, "- `%s` - ", longDisplay) |
There was a problem hiding this comment.
See this comment: https://github.com/hashicorp/hcp-docs/pull/877#discussion_r1531294569
dadgar
force-pushed
the
docs/style-updates-auto-gen
branch
from
a2c3e49 to
77cab1d
Compare
|
Mentioned offline, we will have to tweak the flag indents before merging
|
|
If |
Addressed this in edca4ca!
|
| $ hcp iam workload-identity-providers create-cred-file \ | ||
| iam/project/123/service-principal/my-sp/workload-identity-provider/aws \ | ||
| --aws \ | ||
| --output-file=credentials.json | ||
| `), | ||
| }, | ||
| { | ||
| Preamble: `Create a credential file for a GCP workload:`, | ||
| Preamble: `Create a credential file for a GCP workload.`, |
There was a problem hiding this comment.
Should end with a colon not period
This PR is a companion to https://github.com/hashicorp/hcp-docs/pull/877 and fixes the majority of the suggestions.