Documentation

[ollieread]

The following are the documentation pages that need to be written:

• Getting Started
  • Installation
  • Configuration
• Core Concepts
  • Tenants
  • Tenant Providers
  • Tenancies
  • Identity Resolvers
  • Service Overrides
  • Multitenanted Context
  • Resolution Hooks
  • Exceptions
  • Tenancy Options
  • Internal Settings
• Eloquent
  • Tenant Models
  • Tenant Child Models
• Tenant Providers
  • Eloquent
  • Database
  • Custom
• Identity Resolvers
  • Subdomain
  • Path
  • Header
  • Cookie
  • Session
  • Custom
• Service Overrides
  • Storage
  • Jobs
  • Cache
  • Auth
  • Cookies
  • Sessions
  • Custom
• Packages
  • First-party Packages

Documentation available at: https://sprout.ollieread.com/docs/1.x

[ollieread]

The following documentation needs to be updated for refactors:

• Getting Started — Configuration
  • The sprout config has moved to sprout.core
  • The sprout.services option has its file sprout.overrides
  • Service overrides are now configured differently
• Core Concepts — Service overrides
  • Deferrable service overrides no longer exist
  • Service overrides are now handled by a dedicated ServiceOverrideManager, with a different set of methods
• Service Overrides — Storage
  • Has been renamed to FilesystemOverride
  • Can optionally replace vanilla FilesystemManager (does by default)

[ollieread]

A note will need to be added regarding switching tenants for different requests when testing, which won't work because of how Laravel handles that.

[ollieread]

I'm adding a note here that I'm rejigging the documentation ever so slightly.