Skip to content
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

add instructions for deploying to a cloud provider #2843

Merged
merged 3 commits into from Mar 9, 2021
Merged

Conversation

bpmct
Copy link
Member

@bpmct bpmct commented Mar 8, 2021

I have been working on the cdr/deploy-code-server project which includes one-click buttons and guides to deploy code-server to a cloud provider, such as Linode or Heroku.

deploy-code-server repo

@jsjoeio and I have been discussing including parts of this in the code-server repo, as it is a great way to get started using it. It is only a few steps to get an environment that can be accessed from anywhere!

However, I think that we cannot simply add all of the docs and guides to this repo. Here's why:

  • Certain providers (such as Heroku and Railway) require that some info lives in the base directory of the repository, such as the heroku.yml flle. This would mess up code-server's folder structure.
  • Since the latest code-server version is the default branch, users will not see updates for deploy options until the next version. We may add support for other cloud providers or add fixes before then
  • Providers like Railway and Heroku involve the user "forking" the repo to their account so they can modify their environment. It wouldn't be ideal for the user to fork the whole code-server codebase

However, it may be valuable to add links to deploy to certain providers instead of linking to the entire project. We could include a partial table to README or install.md to include this info?

I think the source-of-truth for the docs and guides should live on the separate deploy-code-server repo though

Currently, our install.md currently has (now outdated) instructions for deploying. We could also add there.

@bpmct bpmct requested a review from a team as a code owner March 8, 2021 21:34
@bpmct bpmct marked this pull request as draft March 8, 2021 21:51
@jsjoeio jsjoeio added this to the v3.9.2 milestone Mar 8, 2021
Copy link
Contributor

@jsjoeio jsjoeio left a comment

Choose a reason for hiding this comment

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

I like what you added to the README.md.

I think the source-of-truth for the docs and guides should live on the separate deploy-code-server repo though

Agreed! I like the approach you've taken - add a short text snippet and link out to that repo.

I think we should update the install.md as well like you said then merge this

README.md Outdated Show resolved Hide resolved
@bpmct
Copy link
Member Author

bpmct commented Mar 8, 2021

So, currently the install script takes up a large % of the README, which I think is good. However, are there potentially other things we could do to draw attention to this "quick deploy" option?

A few ideas:

  • put a badge like this somewhere (lol): deploy-code-server
  • add a small table/button to deploy to ONE cloud provider, which links to the guide on the external repo
  • do nothing, step 3 will be visible enough for more people :)

@jsjoeio
Copy link
Contributor

jsjoeio commented Mar 8, 2021

I could be on board with any of those options! I'll defer to you on which you think is best :D

@bpmct
Copy link
Member Author

bpmct commented Mar 9, 2021

Ok I ended up just adding an emoji lol

@bpmct bpmct marked this pull request as ready for review March 9, 2021 00:01
@bpmct bpmct requested a review from jsjoeio March 9, 2021 00:02
Copy link
Contributor

@jsjoeio jsjoeio left a comment

Choose a reason for hiding this comment

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

Looks great! Ship it!

mando flying

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants