Skip to content

docs: simplify install docs #11946

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 5 commits into from
Mar 8, 2024
Merged

docs: simplify install docs #11946

merged 5 commits into from
Mar 8, 2024

Conversation

bpmct
Copy link
Member

@bpmct bpmct commented Jan 30, 2024

While we support a diverse amount of installation methods, only power users will want to use a system service/non-install script. Folks who want to run a system service on a full-time VM should understand how to start it and keep it running. We can always make a guide/tutorial for this that walks through the basics

Before After
Screenshot 2024-01-30 at 4 18 30 PM image

Main concerns with the old one:

  • Nested tabs
  • Too many decisions for a novice user

@bpmct bpmct requested a review from matifali January 30, 2024 22:20
@bpmct bpmct requested a review from kylecarbs January 30, 2024 22:20
matifali

This comment was marked as outdated.

@matifali matifali self-requested a review January 30, 2024 22:39
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

I am ok with this refactoring but we are now removing all the other installation methods we support. We should have them somewhere for the people who need.

Probably the full original detailed installation methods could be moved to a tutorial or guide in the guides section.
I don't think we should just delete it.

Could you copy the existing install sh as is to a new guide with a title "How to install Coder?"

Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

I revisited and agree with the refactoring. A few suggestions regarding wrong/old links and it's good to merge.

@matifali matifali added the docs Area: coder.com/docs label Jan 31, 2024
@matifali
Copy link
Member

matifali commented Feb 5, 2024

@bpmct, do you want to make any further changes before merging?

@bpmct
Copy link
Member Author

bpmct commented Feb 6, 2024

Yeah, I have several changes planned! Should have the rest pushed soon

@github-actions github-actions bot added the stale This issue is like stale bread. label Feb 14, 2024
@github-actions github-actions bot closed this Feb 18, 2024
@matifali
Copy link
Member

@bpmct I think you still want to complete this.

@matifali matifali reopened this Feb 18, 2024
@github-actions github-actions bot removed the stale This issue is like stale bread. label Feb 19, 2024
@github-actions github-actions bot added the stale This issue is like stale bread. label Feb 27, 2024
@github-actions github-actions bot closed this Mar 2, 2024
@bpmct bpmct reopened this Mar 7, 2024
@bpmct bpmct enabled auto-merge (squash) March 7, 2024 23:34
@github-actions github-actions bot removed the stale This issue is like stale bread. label Mar 8, 2024
@bpmct bpmct merged commit 1e17782 into main Mar 8, 2024
@bpmct bpmct deleted the install-docs branch March 8, 2024 15:16
@github-actions github-actions bot locked and limited conversation to collaborators Mar 8, 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.

2 participants