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

Move documentation about running data mungers from PR descriptions into repo #134

Open
AetherUnbound opened this issue May 29, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Good hacktoberfest issues

Comments

@AetherUnbound
Copy link
Collaborator

There are a number of PR descriptions that have excellent guides on how to run various data munging scripts and upload them in production. This information is pretty vital and should probably exist within the repo. Case in point: #74

@AetherUnbound AetherUnbound added the documentation Improvements or additions to documentation label May 29, 2022
@ambertests
Copy link

Hi, I'd love to contribute to this project and this seems like it could be a good first issue to take on.

@AetherUnbound
Copy link
Collaborator Author

Hi @ambertests, thanks for reaching out! 😄 We mostly want to move that PR documentation into separate markdown files within the repo. Alternatively we could add them to the docstrings for the module and set up Sphinx/GitHub Pages documentation, but that's a lot more complex 😅 Up to whatever you're comfortable with! I'll assign you, let us know if you run into any trouble 🙂

@AetherUnbound AetherUnbound added hacktoberfest Good hacktoberfest issues good first issue Good for newcomers labels Oct 2, 2022
@AetherUnbound
Copy link
Collaborator Author

The PRs that could use documentation:
#42
#39
#50
#74
#51
#52
#73
#89
#99

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Good hacktoberfest issues
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants