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

Retire the "Setting up Your Development Environment" Google doc #15

Closed
seanh opened this issue Jul 30, 2022 · 1 comment
Closed

Retire the "Setting up Your Development Environment" Google doc #15

seanh opened this issue Jul 30, 2022 · 1 comment
Assignees

Comments

@seanh
Copy link
Contributor

seanh commented Jul 30, 2022

Problem

The documentation for how to set up a Hypothesis development environment from scratch currently lives in the Google doc Setting up Your Development Environment. Nobody likes Google docs, the formatting is a pain, and Hypothesis seems to be moving away from Google docs generally.

Solution

  1. The plan is to tidy up and make consistent the dev env setup docs in the project's themselves which will make the Google doc much shorter as it'll only need to link to the HACKING.md files of the projects the user should set up, it won't need to repeat the install steps itself. See Deduplicate development environment set up docs, and make them consistent #14

  2. What's left of the Google doc is then planned to move into the onboarding repo.

  3. We should then retire the original Google docs: perhaps tombstone is by replacing the contents with a link to the onboarding repo's copy, perhaps move the doc to an archive folder, perhaps delete it

@seanh seanh changed the title Retire the **Setting up Your Development Environment** Google doc Retire the "Setting up Your Development Environment" Google doc Jul 30, 2022
@seanh
Copy link
Contributor Author

seanh commented Aug 2, 2022

Closing this in favour of #22, #14, and #17

@seanh seanh closed this as completed Aug 2, 2022
@seanh seanh self-assigned this Aug 2, 2022
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

No branches or pull requests

1 participant