couscous.yml

template:
    # Name of the directory containing the website template (default is "website")
    directory: website/template

exclude:
    - demo
    - runtime
    - src
    - template
    - tests
    - vendor
    - website
    # This special entry will ask Couscous to read the excluded directories from your ".gitignore" file
    - "%gitignore%"

scripts:
    # Scripts to execute before generating the website
    before:
        - make website-assets

menu:
    intro:
        -   section: Getting started
            items:
                what-is-bref:
                    text: What is Bref and serverless?
                    url: /docs/
                installation:
                    text: Installation
                    url: /docs/installation.html
                first-steps:
                    text: First steps
                    url: /docs/first-steps.html
                runtimes-introduction:
                    text: Introduction to PHP runtimes
                    url: /docs/runtimes/

    webHosting:
        -   section: 'Bref for <strong class="text-gray-700">web apps</strong>'
            items:
                web-apps:
                    text: Web apps on AWS Lambda
                    url: /docs/runtimes/http.html
                websites:
                    text: Website assets
                    url: /docs/websites.html
                    title: Building complete websites with Bref
                console-applications:
                    text: Console commands
                    url: /docs/runtimes/console.html
                web-cron:
                    text: Cron commands
                    url: /docs/web-apps/cron.html
                    title: CLI cron tasks
                web-local-development:
                    text: Local development
                    url: /docs/web-apps/local-development.html
                web-docker:
                    text: Docker
                    url: /docs/web-apps/docker.html
        -   section: Frameworks
            items:
                laravel:
                    text: Laravel
                    url: /docs/frameworks/laravel.html
                    title: Learn how to deploy serverless Laravel applications
                symfony:
                    text: Symfony
                    url: /docs/frameworks/symfony.html
                    title: Learn how to deploy serverless Symfony applications

    functions:
        -   section: 'Bref for <strong class="text-gray-700">event-driven functions</strong>'
            items:
                php-functions:
                    text: PHP functions on AWS Lambda
                    url: /docs/runtimes/function.html
                typed-handlers:
                    text: Typed handlers
                    url: /docs/function/handlers.html
                function-local-development:
                    text: Local development
                    url: /docs/function/local-development.html
                cron-function:
                    text: Cron functions
                    url: /docs/function/cron.html

    other:
        -   section: Workflow
            items:
                deploy:
                    text: Deployment
                    url: /docs/deploy.html
                monitoring:
                    text: Monitoring
                    url: /docs/monitoring.html
        -   section: Environment
            items:
                serverless-yml:
                    text: serverless.yml
                    url: /docs/environment/serverless-yml.html
                    title: Configure your application with the serverless.yml file
                variables:
                    text: Variables
                    url: /docs/environment/variables.html
                    title: Configuring environment variables with Bref
                php:
                    text: PHP
                    url: /docs/environment/php.html
                    title: Configuring PHP versions and options with Bref
                storage:
                    text: Storage
                    url: /docs/environment/storage.html
                    title: Storing files and data with Bref on AWS Lambda
                logs:
                    text: Logs
                    url: /docs/environment/logs.html
                    title: Managing logs with Bref on AWS Lambda
                database:
                    text: Databases
                    url: /docs/environment/database.html
                    title: Using a database from AWS Lambda
                database-planetscale:
                    text: Databases - PlanetScale
                    url: /docs/environment/database-planetscale.html
                    title: Using PlanetScale from AWS Lambda
                custom-domains:
                    text: Custom domains
                    url: /docs/environment/custom-domains.html
                    title: Configuring custom domain names
                performances:
                    text: Performance
                    url: /docs/environment/performances.html
                    title: Performance tuning and optimizations
        -   section: Upgrading
            items:
                v2:
                    text: Upgrading to v2
                    url: /docs/upgrading/v2.html
                    title: Upgrading Bref applications to Bref v2
        -   section: Learning
            items:
                course:
                    text: Course
                    url: https://serverless-visually-explained.com/?ref=bref-menu
                    title: Serverless Visually Explained
                case-studies:
                    text: Case studies
                    url: /docs/case-studies.html
                    title: A collection of case studies of serverless PHP applications built using Bref.
                community:
                    text: Community
                    url: /docs/community.html
                    title: Places where to learn and exchange about Bref.
        -   section: Ecosystem
            items:
                github:
                    text: GitHub
                    url: https://github.com/brefphp
                    title: Bref on GitHub
                twitter:
                    text: Twitter
                    url: https://twitter.com/brefphp
                    title: Bref on Twitter
                slack:
                    text: Slack
                    url: https://join.slack.com/t/brefworkspace/shared_invite/enQtNTcwMjU2NTcxNjAxLTIxYmM2MmRjMDkzYjdjYTNkMmE5NGI3YTcyZjc2ZGRjNTFmNjFmYzk5NWQ1YmVhMDkwNzExNzhjZThkZWM0ODE
                    title: Join the Slack community
                dashboard:
                    text: Bref Dashboard
                    url: https://dashboard.bref.sh/?ref=bref
                    title: Bref Dashboard