add gitpod config #5465
Merged
add gitpod config #5465
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cdrini
reviewed
Jul 27, 2021
cdrini
approved these changes
Jul 27, 2021
|
@cdrini added your changes, this is ready to merge |
cdrini
approved these changes
Jul 28, 2021
|
Working like a charm now! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In efforts to get GitHub Codespaces to work (#5438) I discovered gitpod.io and got it working.
In short, gitpod is an IDE that runs in the cloud and has a generous free plan. It has the major benefit of requiring zero setup for users to get started making small fixes.
As Mek mentioned, Open Library generally tries to avoid having tool specific files to the repo. However, adding this file will make it significantly easier for new users to start developing.
Right now, gitpod has a pretty generous free plan of 50 hours a month (or 100 hours for students). While we don't want to depend on that I'd say we should utilize it while we can. They also are an open source project so I'm hopeful they'll keep something nice going for the open source community.
PS: I plan to make a short video showing how to get started with gitpods but to do that I'd like to have this working on the main repo not just my fork :)
Technical
chown
The most important thing to discuss here is that we run the command
sudo chown -R gitpod:999 /workspace/openlibrary/You can see an explanation for why here - gitpod-io/gitpod#4851
In short it just has to do with the fact that we use the
/openlibraryfolder for docker. But gitpods by default uses that path already for the cloned repo. There seems to be a small risk that files could conflict but unless we want to change the folder we mount to there isn't much else we can do.Tasks
You can read more about tasks here but in short the things in the
initstep only run once and then are cached for all users.The
commandis the part that runs as soon as a user starts the app.Ports
We ignore all but the 8080 port. All this does it prevent small popups for each port. It's still quite easy to see what's going on with the other ports.
Testing
I guess the easiest way is to test with my branch.
I also posted a video in slack here.
Screenshot
Stakeholders