-
Notifications
You must be signed in to change notification settings - Fork 4
Add decisions section to onboarding docs. #4
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
Open
brentmclark
wants to merge
3
commits into
Rebuild-Black-Business:master
Choose a base branch
from
brentmclark:patch-2
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Decisions | ||
|
|
||
| All questions and concerns that have come up will be documented here along with their answers. | ||
|
|
||
| ### What, if anything, should we do to safeguard the public-facing data on this site? | ||
|
|
||
| The data on this site was public to begin with. Scraped from other public sites, or given to us to use publicly with consent. | ||
| Therefore, no actions to safeguard the company data on this site need to be taken. | ||
| This includes not needing to safelist/blocklist IP addresses with technology such as cloudflare. | ||
|
|
||
| We should, of course, be up front about data privacy and take all necessary precautions with any private information we may have. | ||
|
|
||
| ### Why are we scraping data from public sites? | ||
|
|
||
| We are scraping data from public sites in order to jump-start this project with an initial set of data large enough to be useful to the visitors of the site. | ||
|
|
||
| Without this data, the goal of becoming a viable resource for those in need will be considerably more difficult to achieve. | ||
|
|
||
| ### Do we need a server at all? | ||
|
|
||
| We have yet to identify any true need for a server at the time of launch. All scrapers can be launched manually and from the developers local machine. | ||
|
|
||
| ### Should we get consent from the businesses we list prior to listing them? | ||
|
|
||
| We've determined that consent is not required in the case where we are scraping publicly-available information from publicly-available websites. | ||
|
|
||
| We will, however, offer an option for a business to remove themselves from the site. | ||
|
|
||
| ### How often will the scrapers run? | ||
|
|
||
| Initially just once at the beginning to seed the site with data. We are unsure how frequently they will run after | ||
| the initial launch, but right now we're thinking they will run monthly. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,3 +26,7 @@ Back-end developer responsibilites within the org include the following: | |
| Tasks will be added to Trello. Anything in the "Intake" column is fair game. If you see a task that you are willing to tackle, please assign it to yourself, and include a comment tagging the Team Lead / Project Manager. This comment should include a _rough_ estimate of when you anticipate completing the task. As a volunteer organization we want to make sure that tasks do not sit idle for long. | ||
|
|
||
| If you need help with a task, or have encountered a task that is more complicated than you expected, please don't hesitate to reach out to any of the points of contact above and we will advise on how to best get that task finished! Overcommunication is key so we can work quickly in these chaotic times. | ||
|
|
||
| ## Decisions | ||
|
|
||
| All decisions that have been made are captured in the [decision log](./Decisions.md). Please check there for questions that have already been raised an answered. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and* answered |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a sentence fragment. Suggestion:
"We compiled public data. and we were given data with consent for public use."
Something like that? We can mention scraping if we want. IANAL, but I don't think it's that important to clarify scraping vs manual curation. (I'm also attempting to stay away from a passive voice, though that's less crucial.)