Skip to content

docs: add dogfooding guide #3099

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 22, 2022
Merged

docs: add dogfooding guide #3099

merged 1 commit into from
Jul 22, 2022

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Jul 21, 2022 •
edited
Loading

Description

This adds the v2/coder dogfooding guide from our internal Notion to the /docs repo.

🖼️ Rendered

Additional Notes

I wasn't sure if this should show up on coder.com/docs. Added to /docs/dogfood so it wouldn't. Sourcegraph does publish theirs, in case we want to go the other route.

@jsjoeio jsjoeio requested a review from ammario as a code owner July 21, 2022 18:36
@jsjoeio jsjoeio marked this pull request as draft July 21, 2022 18:36
@jsjoeio jsjoeio requested review from johnstcn, ketang and presleyp July 21, 2022 18:36
@jsjoeio jsjoeio self-assigned this Jul 21, 2022
@jsjoeio jsjoeio added the docs Area: coder.com/docs label Jul 21, 2022
kylecarbs
kylecarbs reviewed Jul 21, 2022
View reviewed changes
Copy link
Member

@kylecarbs kylecarbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest we place this in the dogfood folder instead, we wouldn't want this to accidentally be placed on coder.com/docs ;p

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Jul 21, 2022

I'd suggest we place this in the dogfood folder instead, we wouldn't want this to accidentally be placed on coder.com/docs ;p

lol good call! i was going to ask if we wanted to hide from the docs website.

presleyp
presleyp reviewed Jul 21, 2022
View reviewed changes
@jsjoeio jsjoeio marked this pull request as ready for review July 21, 2022 18:43
kylecarbs
kylecarbs reviewed Jul 21, 2022
View reviewed changes
Copy link
Member

@kylecarbs kylecarbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current instructions to dogfood Coder locally don't align with using dev.coder.com. I think this set of instructions could work:

  1. Go to https://dev.coder.com/templates/coder-ts. If you don't have an account, sign in with GitHub
  2. Create a workspace
  3. [Connect with your favorite IDE)(https://coder.com/docs/coder-oss/latest/ides)
  4. Clone the repository: git clone git@github.com:coder/coder.git
  5. ... the rest of the steps for running Coder

johnstcn
johnstcn reviewed Jul 21, 2022
View reviewed changes
johnstcn
johnstcn reviewed Jul 21, 2022
View reviewed changes
johnstcn
johnstcn reviewed Jul 21, 2022
View reviewed changes
johnstcn
johnstcn approved these changes Jul 21, 2022
View reviewed changes
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.

Thanks @jsjoeio!

@ammario
Copy link
Member

ammario commented Jul 21, 2022

As kyle suggested the official template is coder-ts.

I also second that this should go in the dogfood/ folder since the method is inaccessible to the average docs viewer.

@jsjoeio jsjoeio force-pushed the jsjoeio/add-dogfooding-guide branch from 562dd1d to 82a27a3 Compare July 21, 2022 20:27
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Jul 21, 2022

Thanks everyone for the helpful feedback!

@kylecarbs I think I addressed everything you brought up. Ready for another review!

@jsjoeio jsjoeio requested a review from kylecarbs July 21, 2022 20:28
jsjoeio
jsjoeio commented Jul 22, 2022
View reviewed changes
jsjoeio
jsjoeio commented Jul 22, 2022
View reviewed changes
kylecarbs
kylecarbs approved these changes Jul 22, 2022
View reviewed changes
Copy link
Member

@kylecarbs kylecarbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

ammario
ammario requested changes Jul 22, 2022
View reviewed changes
Copy link
Member

@ammario ammario left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's still in the docs/ folder.

@jsjoeio jsjoeio force-pushed the jsjoeio/add-dogfooding-guide branch from 129ae11 to 3842679 Compare July 22, 2022 18:13
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Jul 22, 2022

It's still in the docs/ folder.

Ah, I misunderstood and didn't realize we were talking about /dogfood at the root (didn't know that existed). Fixed!

@jsjoeio jsjoeio requested a review from ammario July 22, 2022 18:14
@jsjoeio jsjoeio enabled auto-merge (squash) July 22, 2022 18:16
@jsjoeio jsjoeio merged commit 2dd98c7 into main Jul 22, 2022
@jsjoeio jsjoeio deleted the jsjoeio/add-dogfooding-guide branch July 22, 2022 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnstcn johnstcn johnstcn approved these changes

@presleyp presleyp presleyp approved these changes

@kylecarbs kylecarbs kylecarbs approved these changes

@ammario ammario ammario approved these changes

@ketang ketang Awaiting requested review from ketang

Assignees

@jsjoeio jsjoeio

Labels
docs Area: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jsjoeio @ammario @presleyp @johnstcn @kylecarbs