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

Explain the distinctions between local installation and Codespaces, and switching between them #15

Closed
StevenMaude opened this issue Feb 27, 2024 · 0 comments · Fixed by opensafely/documentation#1495
Labels
documentation Improvements or additions to documentation

Comments

@StevenMaude
Copy link

StevenMaude commented Feb 27, 2024

We should make it clear in our documentation that users can run locally and/or in Codespaces, at any point of development.

There are some points in the process of developing an OpenSAFELY project where the users might want to migrate from Codespaces to a local installation.

Tasks

  1. Ensure that the main tutorial documentation focuses on Codespaces first, with a brief mention that other installation routes are possible, if:
  2. Explain elsewhere:
    • Any limitations of Codespaces.
    • That the same setup can be used on your own computer, if you have VSCode and Docker installed.
    • It is possible to use an entirely ad-hoc development setup
      • And perhaps that we cannot provide (much? any?) support for this.
  3. Move the existing installation guidance to some "For advanced users" section or similar.
  4. Run through this guidance with copilots?

Assumptions

That a local dev container setup does work the same as in Codespaces (see #19).

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

Successfully merging a pull request may close this issue.

1 participant