Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added deprecation note in readme file #47

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# Contentstack import utility
# Deprecation Warning

The import utility has been deprecated. We will soon stop supporting this utility. We recommend you to use [Contentstack CLI](https://github.com/contentstack/cli) instead.

## Contentstack import utility

Contentstack is a headless CMS with an API-first approach that puts content at the centre. It is designed to simplify the process of publication by separating code from content.

This tool helps you to import content which is exported using [contentstack-export](https://github.com/contentstack/contentstack-export) utility into another stack.
This tool helps you to import content which is exported using [contentstack-export](https://github.com/contentstack/contentstack-export) utility into another stack.

## Installation

Download this project and install all the modules using following command.

```bash
$ npm install
```

## Configuration

Update configuration details at config/index.js

```js
Expand All @@ -26,23 +32,28 @@ Update configuration details at config/index.js
management_token: '' //Stack management_token
data: '' // The data that's to be exported. This is generally the one exported via the contentstack-export utility. ex: '../contentstack-export/contents'. Kindly provide the relative path to the directory
```

For switching to EU region update the hosts at config/default.js

```js
{
host:'https://eu-api.contentstack.com/v3',
...
}
```
```

## Usage

Once all things are configured, you can run following commands

1. Import all modules [ assets, locales, environments, extensions, webhooks, global_fields, content_types, entries, labels ]

```bash
$ npm run import
```

2. Import a specific module

```bash
$ npm run import-locales
$ npm run import-env
Expand All @@ -55,18 +66,21 @@ $ npm run import-entries
$ npm run import-labels

```

> Note: Before importing entries you must have to import locales, assets and content types.

> Note: If you keep the value of preserveStackVersion to true, then you will have to provide the email and password mandatorily in the config file, the management token will not work in that case

### Known Limitations and Issues
* It will migrate only latest published version of entry.
* Does not support the following
* Roles
* Users
* Releases
* Workflow
* If 2 different versions of the same asset have the same file name, only the 1st version will be imported

- It will migrate only latest published version of entry.
- Does not support the following
- Roles
- Users
- Releases
- Workflow
- If 2 different versions of the same asset have the same file name, only the 1st version will be imported

## License

This project is licensed under MIT license
Loading