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

Ready repository for external contributors #262

Open
kshepard opened this issue Aug 3, 2020 · 1 comment
Open

Ready repository for external contributors #262

kshepard opened this issue Aug 3, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@kshepard
Copy link
Contributor

kshepard commented Aug 3, 2020

Overview

The top of the README has a statement mentioning that it is not yet ready for public-use. I believe we've gotten the repository to the point where it is much closer to MVP-ready, and there are only some minor changes needed to allow someone outside of Azavea to get spun up. I think the main barrier is related to our AWS credentials and bucket. If we were to make this configurable and add instructions for a user to set up an AWS account/bucket for data storage, then I think we would be able to remove this README clause. We should also host an example GeoJSON input file, so a user can pull it down, process it, and publish it to their bucket in order to get started.

Acceptance criteria

  • README is updated to remove the "not for public use" clause, and have instructions for getting started with development
  • The AWS account/bucket is configurable
  • An example GeoJSON input file is published with instructions on how to process and publish it for local development use
@dmcglone
Copy link
Collaborator

dmcglone commented Jan 7, 2022

We still need to update the readme with a GeoJSON you can use

@dmcglone dmcglone added documentation Improvements or additions to documentation and removed operations size: 2 labels Jan 7, 2022
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
Projects
None yet
Development

No branches or pull requests

3 participants