search

microsoft / scalar

Scalar: A set of tools and extensions for Git to allow very large monorepos to run on Git without a virtualization layer
MIT License
1.39k stars 63 forks source link

Update Readme.md and documentation with helpful info #434

Closed derrickstolee closed 4 years ago

derrickstolee commented 4 years ago

Our Readme.md file is not incredibly helpful. We have changed a lot about our install/upgrade strategy, particularly for macOS. I have fielded several questions about this over email or in issues (e.g. #399).

This PR is a start to revamping our documentation a bit. The Readme now points to the more involved docs/index.md. That directory also gets a "Philosophy of Scalar" document, which I will point to people who are wondering if Scalar is right for them.

You can see how this Readme looks at the front page of a repo by looking at my fork.

Resolves #384.

derrickstolee commented 4 years ago

On the src point, I best not comment since my view here is we shouldn't be doing this at all 😁 We shouldn't be forcing a practice on people - they should change to adopt the practice, or take the file scanning perf hit anyway. (whoops.. I commented)

You're right, we should allow people to opt-out with a --no-src option or something. However, for repos that do the right thing (the Scalar repo itself is an example) we should have happy path that makes it simple. Also, we can't break the existing default behavior for our current customers.