-
-## ⌨️ Usage / Workflow
-This plugin works best when you use `git` for the version control of your Strapi project.
-
-_The following workflows are assuming you're using `git`._
-
-### Intro
-All database records tracked with this plugin will be exported to JSON files. Once exported each change to the file or the record will be tracked. Meaning you can now do one of two things:
-
-- Change the file(s), and run an import. You have now imported from filesystem -> database.
-- Change the record(s), and run an export. You have now exported from database -> filesystem.
-
-### Local development
-When building a new feature locally for your Strapi project you'd use the following workflow:
-
-- Build the feature.
-- Export the config.
-- Commit and push the files to git.
-
-### Deployment
-When deploying the newly created feature - to either a server, or a co-worker's machine - you'd use the following workflow:
-
-- Pull the latest file changes to the environment.
-- (Re)start your Strapi instance.
-- Import the config.
-
-### Production deployment
-The production deployment will be the same as a regular deployment. You just have to be careful before running the import. Ideally making sure the are no open changes before you pull the new code to the environment.
-
-## 🚀 Config types
-
-By default the plugin will track 4 (official) types.
-
-To track your own custom types you can register them by setting some plugin config.
-
-### Default types
-
-These 4 types are by default registered in the sync process.
-
-#### Admin role
-
-> Config name: `admin-role` | UID: `code` | Query string: `admin::role`
-
-#### User role
-
-> Config name: `user-role` | UID: `type` | Query string: `plugin::users-permissions.role`
-
-#### Core store
-
-> Config name: `core-store` | UID: `key` | Query string: `strapi::core-store`
-
-#### I18n locale
-
-> Config name: `i18n-locale` | UID: `code` | Query string: `plugin::i18n.locale`
-
-### Custom types
-
-Your custom types can be registered through the `customTypes` plugin config. This is a setting that can be set in the `config/plugins.js` file in your project.
-
-_Read more about the `config/plugins.js` file [here](#-settings)._
-
-You can register a type by giving the `customTypes` array an object which contains at least the following 3 properties:
-
-```
-customTypes: [{
- configName: 'webhook',
- queryString: 'webhook',
- uid: 'name',
-}],
-```
-
-_The example above will register the Strapi webhook type._
-
-#### Config name
-
-The name of the config type. This value will be used as the first part of the filename for all config of this type. It should be unique from the other types and is preferably written in kebab-case.
-
-###### Key: `configName`
-
-> `required:` YES | `type:` string
-
-#### Query string
-
-This is the query string of the type. Each type in Strapi has its own query string you can use to programatically preform CRUD actions on the entries of the type. Often for custom types in Strapi the format is something like `api::custom-api.custom-type`.
-
-###### Key: `queryString`
-
-> `required:` YES | `type:` string
-
-#### UID
-
-The UID represents a field on the registered type. The value of this field will act as a unique identifier to identify the entries across environments. Therefore it should be unique and preferably un-editable after initial creation.
-
-Mind that you can not use an auto-incremental value like the `id` as auto-increment does not play nice when you try to match entries across different databases.
-
-If you do not have a single unique value, you can also pass in a array of keys for a combined uid key. This is for example the case for all content types which use i18n features (An example config would be `uid: ['productId', 'locale']`).
-
-###### Key: `uid`
-
-> `required:` YES | `type:` string | string[]
-
-#### JSON fields
-
-This property can accept an array of field names from the type. It is meant to specify the JSON fields on the type so the plugin can better format the field values when calculating the config difference.
-
-###### Key: `jsonFields`
-
-> `required:` NO | `type:` array
-
-
-## 🔍 Naming convention
-All the config files written in the sync directory have the same naming convention. It goes as follows:
-
- [config-type].[identifier].json
-
-- `config-type` - Corresponds to the `configName` of the config type.
-- `identifier` - Corresponds to the value of the `uid` field of the config type.
-
-## 🔧 Settings
-The settings of the plugin can be overridden in the `config/plugins.js` file.
-In the example below you can see how, and also what the default settings are.
-
-##### `config/plugins.js`:
- module.exports = ({ env }) => ({
- // ...
- 'config-sync': {
- enabled: true,
- config: {
- syncDir: "config/sync/",
- minify: false,
- soft: false,
- importOnBootstrap: false,
- customTypes: [],
- excludedTypes: [],
- excludedConfig: [
- "core-store.plugin_users-permissions_grant",
- "core-store.plugin_upload_metrics",
- "core-store.strapi_content_types_schema",
- "core-store.ee_information",
- ],
- },
- },
- });
-
-
-### Sync dir
-
-The path for reading and writing the sync files.
-
-###### Key: `syncDir`
-
-> `required:` YES | `type:` string | `default:` `config/sync/`
-
-### Minify
-
-When enabled all the exported JSON files will be minified.
-
-###### Key: `minify`
-
-> `required:` NO | `type:` bool | `default:` `false`
-
-### Soft
-
-When enabled the import action will be limited to only create new entries. Entries to be deleted, or updated will be skipped from the import process and will remain in it's original state.
-
-###### Key: `soft`
-
-> `required:` NO | `type:` bool | `default:` `false`
-
-### Import on bootstrap
-
-Allows you to let the config be imported automaticly when strapi is bootstrapping (on `strapi start`). This setting can't be used locally and should be handled very carefully as it can unintendedly overwrite the changes in your database. **PLEASE USE WITH CARE**.
-
-###### Key: `importOnBootstrap`
-
-> `required:` NO | `type:` bool | `default:` `false`
-
-### Custom types
-
-With this setting you can register your own custom config types. This is an array which expects objects with at least the `configName`, `queryString` and `uid` properties. Read more about registering custom types in the [Custom config types](#custom-types) documentation.
-
-###### Key: `customTypes`
-
-> `required:` NO | `type:` array | `default:` `[]`
-
-### Excluded types
-
-This setting will exclude all the config from a given type from the syncing process. The config types are specified by the `configName` of the type.
-
-For example:
-
-```
-excludedTypes: ['admin-role']
-```
-
-###### Key: `excludedTypes`
-
-> `required:` NO | `type:` array | `default:` `[]`
-
-### Excluded config
-
-Specify the names of configs you want to exclude from the syncing process. By default the API tokens for users-permissions, which are stored in core_store, are excluded. This setting expects the config names to comply with the naming convention.
-
-###### Key: `excludedConfig`
-
-> `required:` NO | `type:` array | `default:` `['core-store.plugin_users-permissions_grant', 'core-store.plugin_upload_metrics', 'core-store.strapi_content_types_schema', 'core-store.ee_information',]`
+See our dedicated [repository](https://github.com/pluginpal/docs) for all of PluginPal's documentation, or view the Config Sync documentation live:
+- [Config Sync documentation](https://docs.pluginpal.io/config-sync)
## 🤝 Contributing
@@ -439,8 +90,10 @@ Give a star if this project helped you.
## 🔗 Links
+- [PluginPal marketplace](https://www.pluginpal.io/plugin/config-sync)
- [NPM package](https://www.npmjs.com/package/strapi-plugin-config-sync)
- [GitHub repository](https://github.com/boazpoolman/strapi-plugin-config-sync)
+- [Strapi marketplace](https://market.strapi.io/plugins/strapi-plugin-config-sync)
## 🌎 Community support
@@ -449,4 +102,4 @@ Give a star if this project helped you.
## 📝 Resources
-- [MIT License](LICENSE.md)
+- [MIT License](https://github.com/pluginpal/strapi-plugin-config-sync/blob/master/LICENSE.md)
diff --git a/admin/src/components/ActionButtons/index.js b/admin/src/components/ActionButtons/index.js
deleted file mode 100644
index 4a30c07..0000000
--- a/admin/src/components/ActionButtons/index.js
+++ /dev/null
@@ -1,57 +0,0 @@
-import React, { useState } from 'react';
-import styled from 'styled-components';
-import { useDispatch, useSelector } from 'react-redux';
-import { isEmpty } from 'lodash';
-import { Button } from '@strapi/design-system';
-import { Map } from 'immutable';
-import { useNotification } from '@strapi/helper-plugin';
-
-import ConfirmModal from '../ConfirmModal';
-import { downloadZip, exportAllConfig, importAllConfig } from '../../state/actions/Config';
-
-const ActionButtons = () => {
- const dispatch = useDispatch();
- const toggleNotification = useNotification();
- const [modalIsOpen, setModalIsOpen] = useState(false);
- const [actionType, setActionType] = useState('');
- const partialDiff = useSelector((state) => state.getIn(['config', 'partialDiff'], Map({}))).toJS();
-
- const closeModal = () => {
- setActionType('');
- setModalIsOpen(false);
- };
-
- const openModal = (type) => {
- setActionType(type);
- setModalIsOpen(true);
- };
-
- return (
- {Object.keys(partialDiff).length} {Object.keys(partialDiff).length === 1 ? "config change" : "config changes"}
- )} -{configName}
+{configType}
+{state}
+
- Loading content...
+ {formatMessage({ id: 'config-sync.ConfigList.Loading' })}
);
}
@@ -114,45 +108,44 @@ const ConfigList = ({ diff, isLoading }) => {
return (
-
|
- |
- |
- |
- |
|---|