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: show how to read collections in SSR mode #840

Closed
jaredcwhite opened this issue Feb 17, 2024 · 2 comments
Closed

docs: show how to read collections in SSR mode #840

jaredcwhite opened this issue Feb 17, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jaredcwhite
Copy link
Member

The SSR / Roda docs are currently lacking information about how to read collections in manually. For example, something like this in an initializer:

  init :ssr do
    setup -> site do
      site.collections.pages.read
      site.collections.some_other_collection.read
    end
  end

Collections aren't loaded by default for performance/memory reasons. We might want an omnibus "read all collections" option though just in case folks are willing to take the performance hit.

@jaredcwhite jaredcwhite added the documentation Improvements or additions to documentation label Feb 17, 2024
@jclusso
Copy link
Contributor

jclusso commented Feb 18, 2024

I ran into this personally so I definitely think docs could be stronger here!

@jaredcwhite
Copy link
Member Author

in v2 we'll have an "inverted" config where collections are all read in by default and there's a per-collection opt-out possibility for performance reasons…will be documented, so closing this one out.

@jaredcwhite jaredcwhite closed this as not planned Won't fix, can't repro, duplicate, stale Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants