search

mwvgroup / pittgoogle-client

Client for the Pitt-Google alert broker
https://mwvgroup.github.io/pittgoogle-client/
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Move our general documentation to a better home #55

Open troyraen opened 4 months ago

troyraen commented 4 months ago

Currently, most of this repo's documentation that is not the API Reference section is actually more general than pittgoogle-client or even python. So we should move it out of this repo to somewhere better.

This kind of documentation was originally in the Pitt-Google-Broker repo but I moved it here because I do not want to point regular users to the broker repo (they don't need any of that code so sending them there is confusing).

The broker's website probably makes the most sense, but that doesn't really exist yet.

troyraen commented 4 months ago

Website work was done in https://github.com/mwvgroup/Broker-Web awhile back by @djperrefort. It is built on Django and runs on Google App Engine. It uses a temporary URL (https://ardent-cycling-243415.appspot.com/).

I looked through that repo and I do not feel it is something that I personally can take on before publishing the paper (I'm not fluent enough with Django), but we do need to link to these docs in the paper. I think it would be better for the paper to point to a main broker website for this, but in reality that could just be a new URL that we redirect here while we work out a better place to move these docs to.

djperrefort commented 4 months ago

I started the Django site a few years ago when I was still learning the framework. Since then I've been working in Django extensively, to the point where I was almost exclusively doing Django work until very recently. Unfortunately, my problem is also time. Taking on any considerable work will be difficult for me while still on FMLA.

Adding static pages is pretty simple, but someone should decide if a CMS is necessary/desirable. Other than that the problem, as always, is time.