search

oss-aspen / 8Knot

Dash app in development to serve open source community visualizations using GitHub data from Augur. Hosted app: https://eightknot.osci.io
MIT License
47 stars 59 forks source link

minor changes to README.md, env requirements #644

Closed JamesKunstle closed 4 months ago

JamesKunstle commented 4 months ago

@cdolfi This updates docs to reflect some changes to the environment requirements and the folder structure. I'm 50/50 on sketching out the caching system before we update the augur replica. What are your thoughts?

cdolfi commented 4 months ago

@JamesKunstle I believe we should bring the docs to date to the current structure, especially with the amount of people trying 8Knot for the first time. I would say if there is portions of it you think will be changed soon I wouldnt go into too much detail

JamesKunstle commented 4 months ago

@cdolfi Which structure are you specifically describing? The caching architecture or the file layout structure?

cdolfi commented 4 months ago

@JamesKunstle Structure is not actually the right word to use here my b. My only concern at this point is that our readme has the updated information on how to locally host and run an 8knot instance. On the description of the caching, maybe just a little burb with a 1 sentance-ish description of what we have now and that it will be updated soon with the new changes

JamesKunstle commented 4 months ago

@cdolfi Okay, I updated the docs to be clearer about how to configure and deploy the application, and a comment about our caching likely changing in the near future. What do you think?