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

docs: simplify outdated dev instructions #1466

Merged
merged 4 commits into from
Jun 26, 2024
Merged

docs: simplify outdated dev instructions #1466

merged 4 commits into from
Jun 26, 2024

Conversation

dshemetov
Copy link
Contributor

@dshemetov dshemetov commented Jun 3, 2024

Summary:

Our dev instructions here are quite old and contain either out of date or duplicate information that is already in dev scripts. So here I removed some unnecessary and out of date details and pointed to the dev scripts instead. This way we don't have to keep updating this instructions along with those files. I did my best to keep the useful examples in the "Manual Tests" section around, such as loading test data into the database and querying the local API directly from the command line (though the diffs make it look like I deleted all that, it's actually kept around unaltered below).

Prerequisites:

  • Unless it is a documentation hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

@dshemetov dshemetov force-pushed the ds/docs2 branch 2 times, most recently from 8ad34b2 to 8cfeb0c Compare June 5, 2024 00:07
@dshemetov dshemetov force-pushed the ds/docs branch 2 times, most recently from d5a58c4 to 203af70 Compare June 5, 2024 18:17
Base automatically changed from ds/docs to dev June 5, 2024 18:25
Copy link
Contributor

@nmdefries nmdefries left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested the commands

docs/epidata_development.md Outdated Show resolved Hide resolved
@dshemetov dshemetov requested a review from nmdefries June 21, 2024 22:50
Copy link

sonarcloud bot commented Jun 26, 2024

@nmdefries nmdefries merged commit c65d809 into dev Jun 26, 2024
7 checks passed
@nmdefries nmdefries deleted the ds/docs2 branch June 26, 2024 21:30
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.

None yet

2 participants