Skip to content

Commit

Permalink
issue #194 - configuration basics documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pounard committed Nov 25, 2024
1 parent 7de47e1 commit 4e7e7af
Show file tree
Hide file tree
Showing 10 changed files with 686 additions and 357 deletions.
2 changes: 1 addition & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default defineConfig({
items: [
{ text: 'Backup & Restore', link: '/backup_restore' },
{ text: 'Statistics', link: '/stats' },
{ text: 'Bundle configuration', link: '/configuration' },
{ text: 'Configuration basics', link: '/configuration/basics' },
{ text: 'Configuration reference', link: '/configuration/reference' },
]
},
Expand Down
8 changes: 4 additions & 4 deletions docs/content/anonymization/essentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ With the Symfony bundle, there is two ways to tell *DbToolsBundle* how it should
2. you can declare it with a **YAML** file

::: tip
The *DbToolsBundle* does not only work with Doctrine Entities to anonymize data. You can use it with
*DbToolsBundle* does not only work with Doctrine Entities to anonymize data. You can use it with
*any* database, all you need is a DBAL connection.

In such case, the [YAML configuration](../configuration#anonymization) is the only available option.
:::

If Doctrine ORM is enabled, the *DbToolsBundle* will automatically look for attributes on your entities.
If Doctrine ORM is enabled, *DbToolsBundle* will automatically look for attributes on your entities.
If you want to use YAML configuration, look at the [Bundle Configuration
section](../configuration#anonymization) to see how to configure it.

Expand Down Expand Up @@ -225,7 +225,7 @@ customer:

## Going further

The DbToolsBundle provides a bunch of *Anonymizers* that should cover most of your needs. You can find a
*DbToolsBundle* provides a bunch of *Anonymizers* that should cover most of your needs. You can find a
complete description of each one of them in the next section.

You can also add *Anonymizers* from [community packs](./packs). For example, to add the `pack-fr-fr` run:
Expand All @@ -234,7 +234,7 @@ You can also add *Anonymizers* from [community packs](./packs). For example, to
composer require db-tools-bundle/pack-fr-fr
```

If you can't find what you need from core anonymizers and in available packs, the *DbToolsBundle* allows
If you can't find what you need from core anonymizers and in available packs, *DbToolsBundle* allows
you to [create your own *Custom Anonymizers*](./custom-anonymizers).

::: tip
Expand Down
2 changes: 1 addition & 1 deletion docs/content/backup_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ php bin/console db-tools:restore --ignore-default-options

## Storage

As mentioned earlier on this page, the *DbToolsBundle* can list existing backup files
As mentioned earlier on this page, *DbToolsBundle* can list existing backup files
when you want to restore a previous one with the restore command.

All backups are stored in a directory. By default this directory is <span class="standalone">`./var/db_tools` (relative to the yaml config file)</span><span class="symfony">`%kernel.project_dir%/var/db_tools`</span>
Expand Down
329 changes: 0 additions & 329 deletions docs/content/configuration.md

This file was deleted.

Loading

0 comments on commit 4e7e7af

Please sign in to comment.