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.

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

docs: Update v2 caching docs #2797

Merged
merged 5 commits into from Oct 26, 2023
Merged

docs: Update v2 caching docs #2797

merged 5 commits into from Oct 26, 2023

Conversation

Levdbas
Copy link
Member

@Levdbas Levdbas commented Sep 15, 2023

Related:

Issue

The caching docs needs some TLC. In this PR I will try to tackle these three tickets at once.

Solution

Better documentation!

Impact

Better understanding of caching in Timber.

Usage Changes

None.

Considerations

None.

Testing

No.

@coveralls
Copy link

coveralls commented Sep 15, 2023

Coverage Status

coverage: 88.525%. remained the same when pulling 96fc0a0 on v2-caching-docs-update into 5149aa7 on 2.x.

docs/v2/guides/performance.md Outdated Show resolved Hide resolved
docs/v2/guides/performance.md Outdated Show resolved Hide resolved
docs/v2/guides/performance.md Outdated Show resolved Hide resolved
@gchtr
Copy link
Member

gchtr commented Sep 21, 2023

I see that you’re still working in this, but thanks a lot for taking this on!

@Levdbas Levdbas marked this pull request as ready for review October 24, 2023 18:40
@Levdbas
Copy link
Member Author

Levdbas commented Oct 24, 2023

Finally took the time to finish the last part and tried to order the guide in a way that makes sense.

@gchtr gchtr added 2.x Future and removed 2.0 labels Oct 26, 2023
@gchtr
Copy link
Member

gchtr commented Oct 26, 2023

Thanks a lot @Levdbas. These updates surely help to understand what’s going on.

I want to take some more time to polish the performance docs. There are some sections in there that could just be deleted, like the TLDR; section and I saw some other details I want to improve.

I’m moving this to 2.x Future.

@Levdbas
Copy link
Member Author

Levdbas commented Oct 26, 2023

Should we just merge this for now @gchtr ? The change about the change at twig/cache-extra is then at least documented when people are going to migrate to 2.0. Let me know what you think.

@gchtr
Copy link
Member

gchtr commented Oct 26, 2023

Should we just merge this for now @gchtr ? The change about the change at twig/cache-extra is then at least documented when people are going to migrate to 2.0. Let me know what you think.

Yeah, maybe that’s better. I created an issue in #2830 and I’m merging this.

@gchtr gchtr merged commit dbb7139 into 2.x Oct 26, 2023
27 of 57 checks passed
@Levdbas Levdbas deleted the v2-caching-docs-update branch November 9, 2023 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants