Closed zisom-hc closed 1 year ago
@zisom-hc is attempting to deploy a commit to the HashiCorp Team on Vercel.
A member of the Team first needs to authorize it.
Just a quick note -
if a user wants to utilize the docker container, there is no documentation for them to go to obtain information about what environment variables they need and can configure.
Keep in mind you can always get the help output from the container as well:
docker run hashicorp/tfc-agent:latest -h
Just a quick note -
if a user wants to utilize the docker container, there is no documentation for them to go to obtain information about what environment variables they need and can configure.
Keep in mind you can always get the help output from the container as well:
docker run hashicorp/tfc-agent:latest -h
Thank you for the insight; i hadn't realized that. i've modified my why statement to reflect this.
This is great, @zisom-hc ! I'm happy to have this type of documentation on the website, and I'll bet users frequently try to find it there.
Regarding the formatting, I think a bulleted list style similar to Nomad's docs may be better suited to this use. It allows the text to flow more naturally and provides more space for longer-form descriptions of the options.
I was also thinking that this documentation might also be prone to staleness. You've inspired me to get this documented though so I took a quick stab at massaging the help output into a markdown format in this PR. Let me know what you think!
Your iteration is much cleaner, and it's awesome that there's some automation to combat staleness as well. Closing out my PR now to be replaced by yours
What
Added a table of all options (flags,parameters,etc.) that are available to used by the TFC agent.
Why
Currently you can only obtain this information by outputting the help message from the TFC agent binary, or docker container. There is currently no documentation for them to go to obtain information about what environment variables they need and can configure. This makes it difficult for practitioner's to discover what's possible, and for support engineering to provide guidance by referring/pointing them to the documentation.
Maybe the information is not best put within a table, or folks may not like the formatting of the table (i used a table generator to be transparent), which is okay. At the very least, i want to get this out to get the ball rolling for implementing this information into our documentation.
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
terraform-website
repositoryredirects.next.js
file.Reviews