New "Caching" doc page - Githubissues

AcademySoftwareFoundation / rez

An integrated package configuration, build and deployment system for software

https://rez.readthedocs.io

Apache License 2.0

938 stars 332 forks source link

New "Caching" doc page #1615

Closed brycegbrazen closed 7 months ago

brycegbrazen commented 8 months ago

Add new caching page
Migrate package caching info to caching page.
Add new section to caching page that describes resolve caching.

TODO:

Need more info on what exactly resolve caching is and how it works. We have a great big writeup for package caching, but prior to now we had no writeup for resolve caching. Would love some help with this new section.

JeanChristopheMorinPerso commented 8 months ago

Hi @brycegbrazen , thanks for creating this PR!

Can you tell us what kind of help you would need?

Some items to cover:

How to setup memcached caching
How do we know that it works (we can use the rez-memcache command to see stats)
What is cached exactly in memcached (hint: resolves are cached, but other things are also cached, like repository metadata (file system layout, etc)).
How are the cache entries invalidated
Benefits and downsides

brycegbrazen commented 8 months ago

@JeanChristopheMorinPerso Honestly, everything you mentioned I don't know the answers to currently. I don't currently use resolve caching at my studio. If I end up filling this out it's going to be me piecing it together by just digging around in the code and making some educated guesses.

I was just hoping someone who was familiar with, or using this feature could help out documenting it I suppose.

JeanChristopheMorinPerso commented 8 months ago

Thanks. It's perfectly fine to not know the answers! If you want to dig in, we can give you hints for where to look at and help you understand how it all works. If not, then we could ask if someone would like to help with this.

brycegbrazen commented 8 months ago

@JeanChristopheMorinPerso That's a great point. I can start by just asking in Slack if anyone is familiar with resolve caching and if they'd be willing to help add some documentation. If we don't hear back from anyone within a week or so I can just dig in myself.

brycegbrazen commented 7 months ago

Alright I've made a big sweeping update over everything. Hopefully this is enough to at least get this out the door. If there's anything else we want in here for this PR just let me know!