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

Remove references to Gitpod #1173

Closed
rebkwok opened this issue Mar 24, 2023 · 5 comments · Fixed by #1398
Closed

Remove references to Gitpod #1173

rebkwok opened this issue Mar 24, 2023 · 5 comments · Fixed by #1398
Assignees

Comments

@rebkwok
Copy link
Contributor

rebkwok commented Mar 24, 2023

Update: we now want to remove Gitpod entirely.


@brianmackenna pointed out that the getting started guide in the docs implies that gitpod is the preferred method of running OpenSAFELY. It currently is not - at least not for committed users. If we continue to support gitpod we may want to consider:

  • stating clearly that approved OpenSAFELY users (as opposed to interested parties just having a look at the tool) should aim to use a local install if possible
  • Switching the order of either the introduction to the options, or the tabs (or both) so that the local install options are shown first
@rebkwok rebkwok changed the title Review Gitpod in getting started guide Review Gitpod prominence in getting started guide Mar 24, 2023
@sebbacon
Copy link
Contributor

Makes sense!

@evansd
Copy link
Contributor

evansd commented Nov 1, 2023

Our Gitpod config no longer works. Example error messages are:

image

image

We're now using Github Codespaces to fulfil the same need, which we have documented here:
https://docs.opensafely.org/github-codespaces/

We should expunge all references to Gitpod from the docs and, where appropriate, replace them with references to Codespaces.

Related threads:
https://bennettoxford.slack.com/archives/C63UXGB8E/p1698849577197769
https://bennettoxford.slack.com/archives/C33TWNQ1J/p1698848977609049

@evansd evansd changed the title Review Gitpod prominence in getting started guide Remove references to Gitpod Nov 1, 2023
evansd added a commit to opensafely/research-template that referenced this issue Nov 1, 2023
Our configuration has gone stale and this no longer works. See:
opensafely/documentation#1173
evansd added a commit to opensafely/research-template that referenced this issue Nov 1, 2023
Our configuration has gone stale and this no longer works. See:
opensafely/documentation#1173
@StevenMaude
Copy link
Contributor

StevenMaude commented Nov 1, 2023

Relatedly, I'd add that:

  • the Getting Started guide might actually want to put "run in Codespaces" as the primary way of seeing how things work (which is what the ehrQL tutorial does), and making "install on your own machine" a further step, given the complications we've seen for local installs 1
  • a fair chunk of the initial ehrQL tutorial likely overlaps with the Getting Started guide, and we may want to consolidate these somehow; it may be as simple as pointing users to the ehrQL tutorial as the first thing to work through

Footnotes

  1. Specifically: user lack of administrative rights; Docker issues on Windows/macOS; quirks of Python installations

@ghickman
Copy link
Contributor

ghickman commented Nov 8, 2023

This landed on the pipeline board, but we're pretty sure it's a data team task, do shout if we've misunderstood something!

@StevenMaude
Copy link
Contributor

StevenMaude commented Nov 23, 2023

This came up again today: https://bennettoxford.slack.com/archives/C63UXGB8E/p1700731771623999?thread_ts=1698849577.197769&cid=C63UXGB8E so I think it should be a reasonable priority in the near future.

@inglesp inglesp moved this to Next in Data Team Nov 28, 2023
@StevenMaude StevenMaude moved this from Next to In Progress in Data Team Nov 28, 2023
@StevenMaude StevenMaude moved this from In Progress to Blocked in Data Team Nov 30, 2023
@StevenMaude StevenMaude moved this from Blocked to Under Review in Data Team Nov 30, 2023
@github-project-automation github-project-automation bot moved this from Under Review to Done in Data Team Dec 6, 2023
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 a pull request may close this issue.

5 participants