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

Update README and enable readthedocs #53

Closed
4 tasks done
helen-m-lin opened this issue May 17, 2024 · 1 comment · Fixed by #99
Closed
4 tasks done

Update README and enable readthedocs #53

helen-m-lin opened this issue May 17, 2024 · 1 comment · Fixed by #99
Assignees

Comments

@helen-m-lin
Copy link
Collaborator

helen-m-lin commented May 17, 2024

Is your feature request related to a problem? Please describe.
As a developer, I want to use an updated README so that I can easily setup and contribute to the repo.

Describe the solution you'd like

  • Add Contribution guidelines, how to run tests/linters, and instructions for running or testing jobs locally.
    • E.g. you must start a ssh session locally and set host to 'localhost' in the JobSettings.
  • Add description and example usage for the new populate_s3 and indexer jobs.
  • Remove legacy jobs from readme
  • Enable readthedocs

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

@helen-m-lin
Copy link
Collaborator Author

Enable readthedocs:

  • add readthedocs yaml
  • create readthedocs account
  • add readthedocs/sphinx files
    Also add mini-description to Readme.

@helen-m-lin helen-m-lin changed the title Update README Update README and enable readthedocs Sep 16, 2024
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 a pull request may close this issue.

1 participant