- Notifications
You must be signed in to change notification settings - Fork928
chore(docs): add missing author to support bundle guide#13918
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
docs/guides/support-bundle.md Outdated
| @@ -1,5 +1,14 @@ | |||
| # Generate and upload a Support Bundle to Coder Support | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
We should probably not add html tags in the markdown and add this information in the markdown header metadata.
Our docs engine then should parse it.
See the modules and templates readme to see what I am talking about.
coder/examples/templates/docker/README.md
Lines 1 to 8 inf21f2dc
| --- | |
| display_name:Docker Containers | |
| description:Provision Docker containers as Coder workspaces | |
| icon:../../../site/static/icon/docker.png | |
| maintainer_github:coder | |
| verified:true | |
| tags:[docker, container] | |
| --- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
We can also do it as part of docs refactor work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Open to adding this with the restructure. I initially hacked the author info together because we rushed guides.
Good call.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Fine for now, we can migrate to parsing markdown header content in a separate PR.
3c2c5ab intomainUh oh!
There was an error while loading.Please reload this page.
Added author info and date to the support bundle guide.
@johnstcn, leaving you as the sole reviewer - not sure if you'd like to intentionally stay anonymous.
Original:#12931