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

gitpod/codespaces support for contributions (especially docs) #4565

Open
minrk opened this issue Sep 12, 2023 · 1 comment
Open

gitpod/codespaces support for contributions (especially docs) #4565

minrk opened this issue Sep 12, 2023 · 1 comment

Comments

@minrk
Copy link
Member

minrk commented Sep 12, 2023

Proposed change

Configuration for gitpod or GitHub codespaces to make it easier to set up a test environment for new contributors. I imagine this primarily for docs contributions, so whatever we use should be able to:

  1. install jupyterhub
  2. build the docs
  3. preview the built docs
  4. push commits (or even issue PRs, but push is most important)

The big risk I see for this is maintenance. It's very unlikely that regular contributors would use this, which puts it at significant risk of being out of date or stale, since I think such things are usually hard to test themselves. And a contributor tool especially for new contributors that goes stale and doesn't actually work seems worse than relying on local installation documentation. But the benefits of zero-install docs contributions where folks can actually see built docs seems significant.

Alternative options

Leave things as they are, rely on local installation.

Who would use this feature?

Mostly novice and first-time contributors.

@ghostdevv
Copy link

Hey, I'm happy to take another look at this PR if you're open to it! (Updated comment with some more helpful information!)

The big risk I see for this is maintenance. It's very unlikely that regular contributors would use this, which puts it at significant risk of being out of date or stale, since I think such things are usually hard to test themselves.

The options in the .gitpod.yml are stable and don't change often, the only surface I could see is if there were major changes to how you run the codebase. We're happy to help out here!

But the benefits of zero-install docs contributions where folks can actually see built docs seems significant.

It's certainly daunting as a new contributor figuring out how to get a project running locally, this is a big win here! I wrote some thoughts about this recently if you wanna read a bit more on CDEs.


We also offer an open source plan to help maintainers with their work without charging them. You'd get at least 2500 credits (250 hours). You can also check our docs, join our community discord, or reach out to me directly if you have any questions.

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

No branches or pull requests

2 participants