Skip to content

Commit

Permalink
Resolve several issues with documentation
Browse files Browse the repository at this point in the history
bryannielsen committed Apr 13, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 5288dbb commit 2d5c8de
Showing 4 changed files with 13 additions and 7 deletions.
8 changes: 8 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -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
```

2 changes: 1 addition & 1 deletion docs/guides/using-twig-templates.md
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ Create a new file at `/ee/system/user/templates/default_site/example.group/entry
</head>
<body>
<h1>{{ entry.title }}</h1>
<span>Published on {{ entry.date }}
<span>Published on {{ entry.entry_date }}</span>
<img src="{{ entry.featured_image }}" />
{{ entry.page_content | raw}}
</body>
8 changes: 2 additions & 6 deletions docs/routing.md
Original file line number Diff line number Diff line change
@@ -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...

0 comments on commit 2d5c8de

Please sign in to comment.