search

rcos / rcos-handbook

Organization documentation for RCOS
https://handbook.rcos.io
MIT License
17 stars 24 forks source link

Future of the Handbook #140

Open rushsteve1 opened 3 years ago

rushsteve1 commented 3 years ago

With the upcoming RCOS infrastructure work, I think it's time to think about the future of the handbook and where it lives. As of now it is hosted with GitHub Pages at https://handbook.rcos.io

Since we are trying to consolidate efforts and infra I think we should look into other options:

  1. Leave it as is as a standalone thing
  2. Integrate into (some version of) Observatory
  3. Copy it into a Wiki
  4. Host it as a static site along with the API and such

Or even something else.

Personally I am a proponent of option 3, but of course am open to other options.

Apexal commented 3 years ago

I think we should play it safe for this semester seeing as what we currently have works, is extremely maintainable, and free to run. Throughout the semester I think we should catalogue any shortcomings of the Handbook we come across so that we can decide on this going forward. Thoughts?

rushsteve1 commented 3 years ago

That makes sense. Maybe it would be better to make it a goal: For this semester we will leave the handbook as is, but we will have a new hosting solution figured out for next semester (or more really, the end of this)

rushsteve1 commented 3 years ago

I copied over the handbook into the wiki and I've been working on reorganizing and reformatting to fit that. I did this over a week ago and I haven't been merging in changes yet.

https://wiki.rcos.io/en/handbook/home https://github.com/rcos/rcos-wiki