From 2d5c8de7ea5c0fc4172777a0d3fcfb778ab4e298 Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Thu, 13 Apr 2023 14:33:08 -0400 Subject: [PATCH] Resolve several issues with documentation --- docs/configuration.md | 8 ++++++++ docs/getting-started.md | 2 ++ docs/guides/using-twig-templates.md | 2 +- docs/routing.md | 8 ++------ 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 2ecdd94..75b2a63 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -10,6 +10,14 @@ If you followed the steps in [Getting Started](./getting-started.md) you should Due to the nature of how ExpressionEngine is loaded through Coilpack you can set variables in your Laravel `.env` and access those values inside of your ExpressionEngine `config.php` file. This can help keep your secrets out of version control and in one central location. We recommend updating your `config.php` to access database credentials and other secrets from the `$_ENV` global. +Certain configuration variables in ExpressionEngine will be overwritten by your Laravel environment and config variables. This is a list of current overrides: + +| Environment | Config | Overwrites Config | Overwrites Control Panel Settings | +| ----------- | ------ | ----------------- | --------------------------------- | +| APP_URL | 'app.url' | $config['base_url'] | URL and Path > Default base URL | +| N/A | 'coilpack.base_path' | $config['base_path'] | URL and Path > Default base path | + + ## Accessing ExpressionEngine Config Values After Coilpack bootstraps ExpressionEngine you will be able to access any of your ExpressionEngine `system/user/config.php` values through the Laravel `config()` helper. For example to get your `app_version` you could call `config('coilpack.expressionengine.app_version')` within your Laravel application. \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md index 9648720..26a6965 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -60,6 +60,8 @@ Now that you have a Laravel Project setup it is a good time to edit the values i Inside of your Laravel project, you will need to update your project to use the Coilpack package. ``` +cd project-name + composer require expressionengine/coilpack:0.x-dev ``` diff --git a/docs/guides/using-twig-templates.md b/docs/guides/using-twig-templates.md index 3014212..c09bf8a 100644 --- a/docs/guides/using-twig-templates.md +++ b/docs/guides/using-twig-templates.md @@ -32,7 +32,7 @@ Create a new file at `/ee/system/user/templates/default_site/example.group/entry

{{ entry.title }}

- Published on {{ entry.date }} + Published on {{ entry.entry_date }} {{ entry.page_content | raw}} diff --git a/docs/routing.md b/docs/routing.md index 384a249..9946cdb 100644 --- a/docs/routing.md +++ b/docs/routing.md @@ -7,8 +7,8 @@ Coilpack works by bootstrapping ExpressionEngine inside of a Laravel application Coilpack sets up a few special routes for you: - `/admin.php` - Access the ExpressionEngine Control Panel -- `/graphql` - GraphQL Data endpoint -- `/graphiql` - Interactive GraphQL testing endpoint +- `/graphql` - GraphQL Data endpoint when [GraphQL is enabled](./graphql#enabling-graphql-support) +- `/graphiql` - Interactive GraphQL testing endpoint when [GraphiQL is enabled](./graphql#tools) ## Asset Handling @@ -58,7 +58,3 @@ protected $routeMiddleware = [ ... ]; ``` - -## Laravel Template Routes - -Documentation Coming Soon... \ No newline at end of file