CenterForOpenScience / COSDev

COS Development Docs
http://cosdev.readthedocs.io
6 stars 34 forks source link

Consolidate OSF README and "Setting up" pages #11

Open sloria opened 9 years ago

sloria commented 9 years ago

We have two places where we have documented how to set up the OSF for local development: the private OSF README and the "Setting up the OSF" page of these docs.

To reduce maintenance needs, I propose we consolidate these into a single document in COSDev.

A few considerations:

Feedback welcome. @JeffSpies @brianjgeiger @caneruguz

h/t to @icereval who brought this to my attention

caneruguz commented 9 years ago

I don't think we should consolidate. The two options serve distinct purposes. The README is a quick guide for people who know what they are doing. These advanced users would not like to read through the details of the COSDev document.

On the other hand the beginners who need handholding will find the details and solutions to problems in COSDev useful. I know that a lot of the people used it when installing OSF and found many aspects of it useful.

However I think both documents need to improve. README is too far in the direction of terse, some more details would help, or maybe making it a little more verbose. While the COSDev document is too verbose, some parts of it might be shortened.

However there remains the need to service the needs of the people with different skill levels. If we want to reduce the places we maintain I think we should move it all to COSDev. When this project becomes open source we will need to spend more time on public documentation that needs to go beyond README anyway.

What do you guys think about Knockout's readme file for instance? : https://github.com/knockout/knockout