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

Github Action > Update Open Brewery DB API #12

Closed
chrisjm opened this issue May 15, 2020 · 6 comments
Closed

Github Action > Update Open Brewery DB API #12

chrisjm opened this issue May 15, 2020 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@chrisjm
Copy link
Contributor

chrisjm commented May 15, 2020

No description provided.

@chrisjm chrisjm added the enhancement New feature or request label May 15, 2020
@chrisjm chrisjm added this to 👥 Community in Public Roadmap Apr 8, 2021
@chrisjm chrisjm moved this from 👥 Community to 🗓 April 2021 in Public Roadmap Apr 8, 2021
@chrisjm chrisjm self-assigned this Apr 10, 2021
@Johnnyk737
Copy link
Contributor

May I ask what the action would be doing? To update the Rails API postgres db on merge to master?

@chrisjm
Copy link
Contributor Author

chrisjm commented May 25, 2021

Yup! Though after our recent conversations, I'm getting less convinced this is the proper way. I like using Github's diff and version control features, but it's not incredibly user-friendly for those who just want to update data.

Now I'm considering a reasonably authenticated and authorized data admin interface which will then collect and open a pull request on this repo. Definitely more complicated, but more user-friendly.

Thoughts?

@Johnnyk737
Copy link
Contributor

Yeah I think that would be interesting. We would probably want to have Github authentication. I think that would just be easier since we're wanting to make a PR out of it. My initial thoughts would be that we could just add this to the gatsby page. I think it would be more work to create a brand new webpage, specifically designed for adding/editing when we already have the existing gatsby page (not to mention cost of hosting). Although, we wouldn't need to host it if we wanted to keep this solely as a locally run page.

Thoughts on functionality
These are a few things that I'd think we would want as base functionality for this interface.

  • Add new breweries
    • Auto finds directory by state input field
  • Edit existing breweries
    • Search by name
  • Bulk add (Add to list, then submit list)
  • Import by json/csv
  • Collect and add as PR (new territory for me)

@chrisjm
Copy link
Contributor Author

chrisjm commented May 27, 2021

Awesome! Thanks for writing up your thoughts. Here are mine! 😄

  • Website integration - While I agree we should bake this into the official OBDB website, I dislike the current Gatsby site. I have great intentions to rebuild the site in Svelte which will still allow it to be hosted via Netlify (definitely not giving up free hosting :) )
  • No split files - This feature would completely remove the need to break out the breweries into separate files. The main purpose of that was to make it easier to update via Github / Pull Request (did it actually make things easier? 🤷 ).
  • Change manager - I think the main feature supplementary feature/tool for this will be the change manager. That is, a tool that will allow moderators to view changes and either accept (add to list) or decline (request edits). I'd like to do some research to see if this tool already exists in another form or if it would be better to build this from scratch.

Overall, this is feeling like a separate issue, perhaps even an epic that needs to be broken down. Also need to decide if this should live here (with the dataset) or with the website repo. 🤔

@Johnnyk737
Copy link
Contributor

I have great intentions to rebuild the site in Svelte which will still allow it to be hosted via Netlify

Yeah I saw your issue for re-making the website in Svelte. I've never used that but I'd like to give it a go. I have no eye for UI design though.

I'd like to do some research to see if this tool already exists in another form or if it would be better to build this from scratch.

I bet we could pull some inspiration from Intellij (https://github.com/JetBrains/intellij-community/search?q=git)

Overall, this is feeling like a separate issue, perhaps even an epic that needs to be broken down. Also need to decide if this should live here (with the dataset) or with the website repo

I definitely agree this is something that is iterative. At least initially, I think it should be part of the main dataset repo. Then build it into the Svelte site. If it's part of the main dataset repo, it's right there and easy to spin up and add to.

I'll open a new issue for this continuing conversation and close this one out.

@chrisjm
Copy link
Contributor Author

chrisjm commented Sep 29, 2021

Closing this issue because as mentioned in the above conversation, it doesn't seem like this is the path forward.

@chrisjm chrisjm closed this as completed Sep 29, 2021
Public Roadmap automation moved this from 🚀 In Progress to ✅ Done Sep 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Development

No branches or pull requests

2 participants