Skip to content

Commit 5c4237c

Browse files
authored
[v5] Adjust the doc for GraphQL being optional (#2754)
* Empty line removal * Made GraphQL usage more opt-in
1 parent ba54ca5 commit 5c4237c

File tree

4 files changed

+1
-7
lines changed

4 files changed

+1
-7
lines changed

docs/api/graphql/graphql.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ The GraphQL implementation for [[= product_name =]] is located in [`ibexa/graphq
1010
## Setup
1111

1212
Using GraphQL requires a domain schema.
13-
The schema is generated automatically when installing [[= product_name =]].
1413

15-
When you modify content types or product types in your installation, you need to regenerate the schema:
14+
Before using GraphQL for the first time, or anytime you modify content types or product types in your installation, you need to generate the schema:
1615

1716
``` bash
1817
php bin/console ibexa:graphql:generate-schema

docs/getting_started/install_ibexa_dxp.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,6 @@ Install [[= product_name =]] and create a database with:
242242

243243
``` bash
244244
php bin/console ibexa:install
245-
php bin/console ibexa:graphql:generate-schema
246245
```
247246

248247
Before executing the command make sure that the database user has sufficient permissions.
@@ -256,7 +255,6 @@ Make sure to use a [strong password](security_checklist.md#strong-passwords) mee
256255

257256
``` bash
258257
php bin/console ibexa:install --no-interaction
259-
php bin/console ibexa:graphql:generate-schema
260258
```
261259

262260
If doing so, [modify the password for the `admin` user](update_basic_user_data.md#change-password) before [going live with your project](security_checklist.md).

docs/getting_started/install_with_ddev.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ Once you've made this change, you can proceed to install [[= product_name =]].
159159

160160
```bash
161161
ddev php bin/console ibexa:install
162-
ddev php bin/console ibexa:graphql:generate-schema
163162
```
164163

165164
### 7. Open browser
@@ -391,7 +390,6 @@ ddev composer install
391390
ddev php bin/console ibexa:install
392391
# Add some content types using a migration file (previously created on another installation) and update the GraphQL schema
393392
ddev php bin/console ibexa:migrations:migrate --file=project_content_types.yaml
394-
ddev php bin/console ibexa:graphql:generate-schema
395393
# Open the project in the default browser which should display the default SiteAccess frontpage
396394
ddev launch
397395
```

docs/infrastructure_and_maintenance/security/security_checklist.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,4 +319,3 @@ to receive notifications when a security fix is released in a GitHub-hosted depe
319319
- Enable logging for [[= product_name =]], the web server, any frontend proxies, and the database.
320320
- Monitor the logs for unusual and suspicious activity. Consider using log monitoring software to make this easier.
321321
- Consider using different accounts for manual administrative tasks and for the day-to-day running of your installation. You could for instance configure [[= product_name =]] to use a different database user than the one you use during upgrades. This can make it easier to filter out noise in your log monitoring solution.
322-

0 commit comments

Comments
 (0)