Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2024

Conversation

stirby
Copy link
Collaborator

@stirby stirby commented Jul 16, 2024

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

@stirby stirby added docs Area: coder.com/docs chore labels Jul 16, 2024
@stirby stirby requested a review from johnstcn July 16, 2024 22:33
@stirby stirby self-assigned this Jul 16, 2024
@@ -1,5 +1,14 @@
# Generate and upload a Support Bundle to Coder Support


Copy link
Member

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.

---
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]
---

Copy link
Member

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.

Copy link
Collaborator Author

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.

Signed-off-by: Cian Johnston <cian@coder.com>
Copy link
Member

@johnstcn johnstcn left a 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.

@johnstcn johnstcn merged commit 3c2c5ab into main Jul 22, 2024
27 checks passed
@johnstcn johnstcn deleted the guide-missing-author branch July 22, 2024 08:09
@github-actions github-actions bot locked and limited conversation to collaborators Jul 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants