Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New "Caching" doc page #1615

Merged
merged 23 commits into from
Jan 29, 2024
Merged

New "Caching" doc page #1615

merged 23 commits into from
Jan 29, 2024

Conversation

brycegbrazen
Copy link
Contributor

  • 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.

@brycegbrazen
Move package caching information to new subpage called Caching along …
feeac1f 
…with new section that describes resolve caching.

Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen brycegbrazen requested a review from a team as a code owner January 12, 2024 23:25
@JeanChristopheMorinPerso
Copy link
Member

JeanChristopheMorinPerso commented Jan 13, 2024 •
edited

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
Copy link
Contributor Author

@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
Copy link
Member

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
Copy link
Contributor Author

@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.

predat
predat reviewed Jan 18, 2024
View reviewed changes
docs/source/caching.rst Outdated Show resolved Hide resolved
@brycegbrazen
Add doc from predat.
caa12fd 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Add some new lines to fix issue with code blocks not appearing.
2562c18 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Add new benefits/downsides section and fix typos, and small reorg.
b7437ff 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Another small cleanup.
031885e 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Add cache invalidation section and more reorg
893c804 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Add section about cache contents
d8a0c89 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Copy link
Contributor Author

brycegbrazen commented Jan 22, 2024 •
edited

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!

JeanChristopheMorinPerso
JeanChristopheMorinPerso reviewed Jan 25, 2024
View reviewed changes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I left a couple of comments that should be easy to address.

docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
@brycegbrazen
Update configuration section. NOTE: The caching cross reference isnt …
07c179c 
…working right now.

Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Remove extra = from Caching header
70820b9 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Move validating operation below cache invalidation.
d8cf7fb 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Cleanup extra - lines
3714703 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Reword stats section
4bb926f 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Move benefits/downsides and dont make them sections.
a0f5ad7 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Add info about memcached, wording fixes
4c0fca8 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Small wording change
ebc2cec 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Small wording change
be3781e 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Cleanup some package caching wording
af03fa3 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
JeanChristopheMorinPerso
JeanChristopheMorinPerso reviewed Jan 26, 2024
View reviewed changes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the edits! Here is another batch of comments.

docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
@brycegbrazen
Sentence rewording
2849742 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Update wording of setup for resolve caching
276c9b5 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
JeanChristopheMorinPerso
JeanChristopheMorinPerso reviewed Jan 27, 2024
View reviewed changes
docs/source/caching.rst Outdated Show resolved Hide resolved
docs/source/caching.rst Outdated Show resolved Hide resolved
@JeanChristopheMorinPerso
* Fix caching reference
8afe28e 
* Tweak caching docs a little bit to be more consistent with the other docs

Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@JeanChristopheMorinPerso
More tweaks
dbeda38 
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@brycegbrazen
Quick typo fix
ae7d711 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
@brycegbrazen
Address wording issue
75997b1 
Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
JeanChristopheMorinPerso
JeanChristopheMorinPerso approved these changes Jan 29, 2024
View reviewed changes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @brycegbrazen and @predat! I think this is a good start and is ready to be merged.

@JeanChristopheMorinPerso JeanChristopheMorinPerso merged commit 24334d3 into AcademySoftwareFoundation:main Jan 29, 2024
5 checks passed
@JeanChristopheMorinPerso JeanChristopheMorinPerso added this to the 3.0.0 milestone Feb 4, 2024
Pixel-Minions pushed a commit to Pixel-Minions/rez that referenced this pull request Feb 14, 2024
@brycegbrazen @JeanChristopheMorinPerso
New "Caching" doc page (AcademySoftwareFoundation#1615)
4aada6d 
With the help of @predat

---------

Signed-off-by: brycegbrazen <bryce.gattis@brazenanimation.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Co-authored-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jose Enriquez <jose.enriquez@barnstormvfx.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@predat predat predat left review comments

@JeanChristopheMorinPerso JeanChristopheMorinPerso JeanChristopheMorinPerso approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
3.0.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@brycegbrazen @JeanChristopheMorinPerso @predat