Skip to content

Add dev container setup #1280

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Aug 28, 2024
Merged

Add dev container setup #1280

merged 3 commits into from
Aug 28, 2024

Conversation

StevenMaude
Copy link
Contributor

@StevenMaude StevenMaude commented Jul 19, 2023 •
edited
Loading

Fixes #1047.

This allows someone to work on the docs via Codespaces or in VSCode using the dev containers feature.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jul 19, 2023 •
edited
Loading

Deploying opensafely-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 121c0ca
Status: ✅  Deploy successful!
Preview URL: https://5580641e.opensafely-docs.pages.dev
Branch Preview URL: https://steve-devcontainer.opensafely-docs.pages.dev

View logs

@StevenMaude StevenMaude mentioned this pull request Aug 2, 2023
Merged
@StevenMaude
Copy link
Contributor Author

StevenMaude commented Aug 2, 2023 •
edited
Loading

Old discussion; either something with my browser, computer or Codespaces changed, because this problem's now gone.

This configuration works as is in a local dev container, and makes the port accessible. I'm having real trouble trying to get Codespaces to make the port available. You can curl localhost:8910 and get the response from the MkDocs server, so the server is running.

There is this discussion: https://github.com/orgs/community/discussions/61154 which might be related. I'm not sure.

I'm similarly having problems even in Codespaces from repositories that I know full well used to work like the research-template and running opensafely jupyter.

There's also mention of an new and forthcoming port forwarding mechanism: https://github.com/orgs/community/discussions/57596

So maybe return to this in a few weeks and try again. I'd prefer to having it working in Codespaces, and be able to validate that myself, before merging.

@StevenMaude
Copy link
Contributor Author

StevenMaude commented Apr 18, 2024 •
edited
Loading

I should try this again, as I'd had similar problems with the team manual, and that just worked when I tried it with Codespaces more recently.

It works fine now.

@StevenMaude StevenMaude marked this pull request as ready for review August 22, 2024 14:51
@StevenMaude StevenMaude changed the title Add rudimentary dev container setup Add dev container setup Aug 22, 2024
@StevenMaude
Add minimal dev container configuration
09897b0 
For editing the site using a dev container locally, or in Codespaces
online.

The `deadsnakes` configuration is taken from the
`research-template-docker` repository:

https://github.com/opensafely-core/research-template-docker/blob/669a76d79c198925d788dedc34fe3c5a831872b5/Dockerfile#L20-L21

which avoids installing `software-properties-common` first (to get the
`add-apt-repository` command.

The dev container settings are based on the Bennett site configuration,
with a longer autosave delay, because the site currently takes a while
to build (#1397). Arguably, the save delay could be longer still.

No Markdown plugins are installed yet; maybe that's something we could
do in future.
@StevenMaude
Set TZ env variable to fix Python babel error
2550c54 
This occurs when attempting to use `just run`.
@StevenMaude
Add some mentions of Codespaces for editing
121c0ca 
This is minimally documented for now.

We could add more comprehensive guidance on editing content using
Codespaces in future.
@tomodwyer tomodwyer self-requested a review August 27, 2024 08:36
@tomodwyer tomodwyer merged commit 4342abc into main Aug 28, 2024
2 checks passed
@tomodwyer tomodwyer deleted the steve/devcontainer branch August 28, 2024 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tomodwyer tomodwyer tomodwyer approved these changes

Assignees

@StevenMaude StevenMaude

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Trial and document the use of Codespaces to work on this repository
2 participants
@StevenMaude @tomodwyer