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

Replace Gitpod with GitHub Codespaces #1398

Merged
merged 9 commits into from
Dec 6, 2023

Conversation

StevenMaude
Copy link
Contributor

@StevenMaude StevenMaude commented Nov 29, 2023

Fixes #1173.

Our Gitpod configuration for the research template stopped working and has now been removed. Instead, we currently have a configuration that works with GitHub Codespaces.

The Getting Started guide could not be followed by users trying to use OpenSAFELY via Gitpod. This PR updates the Getting Started guide to use Codespaces.

We originally added Gitpod when Codespaces wasn't available for all. We now favour GitHub Codespaces because Codespaces doesn't require:

  • an extra user account to be setup, on Gitpod (everything is on GitHub)
  • linking of that extra Gitpod account to the user's GitHub account, to enable repository access (Codespaces already enables this with no additional steps)
  • auditing and approval of another web service in addition to GitHub by IT administrators who manage hardware of OpenSAFELY users, although access to Codespaces might still have to be requested
  • that open virtual machines are managed via a site other than GitHub

All this simplifies the process for users, and our explanations of that process.

We could consolidate some of the other GitHub Codespaces page with this one, as they now overlap, but that can be a future PR.

We are replacing any use of Gitpod with GitHub Codespaces.
This does not yet update the images.
To make it simpler.
@StevenMaude
Copy link
Contributor Author

I think a subsequent improvement would be to consolidate the GitHub Codespaces page with the Getting Started guide. There is some overlap there. We could merge in the sections that refer to creating a demonstration research repository to the Getting Started guide, or remove them entirely.

But this PR at least drops the mention of Gitpod, so that could be a subsequent PR either shortly or when we revisit the Getting Started guide.

Copy link

cloudflare-workers-and-pages bot commented Nov 29, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: ebe6b07
Status: ✅  Deploy successful!
Preview URL: https://dcf81191.opensafely-docs.pages.dev
Branch Preview URL: https://steve-replace-gitpod-with-gi.opensafely-docs.pages.dev

View logs

@StevenMaude
Copy link
Contributor Author

StevenMaude commented Nov 30, 2023

There's a tiny bit of work here to decide:

  • what to do with the other screenshots that were taken, and probably weren't needed pushed these to another branch for now
  • whether some of the screenshots should be cropped to the area of interest — it's the current appearance in the Getting Started guide; but we've kept the screenshots in their entirety in the ehrQL tutorial; see the comment thread from a previous PR there

The content changes could be reviewed now.

It would be better to organise these per directory probably (#1400),
but avoiding that for now. This at least marks more clearly what these
images are for.

Have not renamed the `win-anaconda-prompt.png` and `win-docker-starting.png`
because the `win-docker-starting.png` is used elsewhere.
Remove Gitpod images and replace with GitHub Codespaces.
These are no longer used.
@StevenMaude
Copy link
Contributor Author

I'll leave the screenshots as they are. If we find cropping some of them is better, we could do that in future.

@StevenMaude StevenMaude merged commit 0017e8b into main Dec 6, 2023
2 checks passed
@StevenMaude StevenMaude deleted the steve/replace-gitpod-with-github-codespaces branch December 6, 2023 12:53
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.

Remove references to Gitpod
2 participants