Skip to content

Commit d35d201

Browse files
committed
readme update
1 parent 1e3cf8e commit d35d201

File tree

3 files changed

+46
-12
lines changed

3 files changed

+46
-12
lines changed

README.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,65 @@
11
# red-panda-export
22

3-
### Pre-requisite
3+
### Pre-requisites
44
- Contentstack account
5-
- Contentstack cli installed on your machine.
6-
- Write access to this repository
5+
- Contentstack cli installed on your machine, if not install using:
6+
7+
```
8+
npm i -g @contentstack/cli@latest
9+
```
10+
11+
### Project setup
12+
- Clone the repo using
13+
```
14+
git clone https://github.com/Contentstack-Solutions/red-panda-export.git
15+
```
16+
- Navigate to the root directory, Run
17+
```
18+
npm install
19+
```
20+
21+
### Using Content Directory - Import Content
22+
if you want to import the exported content from this repository follow these steps:
23+
- Navigate to root directory
24+
- Run following command in terminal
25+
26+
```
27+
csdx config:set:region
28+
```
29+
```
30+
csdx auth:login
31+
```
32+
```
33+
csdx cm:stacks:import -k <<DESTINATION_STACK_API KEY>> -d content/main -y
34+
```
35+
<br/>
36+
37+
---
38+
# Revision Scripts
739
840
## Content Update
941
1042
This repository includes scripts to update the exported content from Contentstack.
1143
12-
### Content Update Commands
44+
#### Content Update Commands
1345
1446
```bash
1547
# Update content directory (delete existing and re-export)
1648
npm run content:update
1749
```
1850

19-
### What the Content Update Does:
20-
1. **Deletes** the existing `content` directory
21-
2. **Runs** the Contentstack export command: `csdx cm:export -k bltc991c0dda4197336 -d content`
51+
#### What the Content Update Does:
52+
1. **Deletes** the existing `content` directory
53+
2. **Runs** the Contentstack export command: `csdx cm:export -k <<RED PANDA STACK API KEY>> -d content`
2254
3. **Creates** fresh content export from Contentstack
2355

2456

2557

2658
## Git tag and version update
2759

28-
This repository includes scripts to manage version tags and releases.
60+
This repository includes scripts to manage release tags and their versions. Which will be published and available to use.
2961

30-
### Version Update Commands
62+
#### Version Update Commands
3163

3264
```bash
3365
# Create tag with current package.json version
@@ -48,4 +80,6 @@ npm run version:update minor
4880

4981
# Increment major version (3.3.0 → 4.0.0) and create tag
5082
npm run version:update major
51-
```
83+
```
84+
85+

content_handler.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,10 @@ if (require.main === module) {
9898
📁 Content Directory Updater
9999
100100
Usage:
101-
node content_handler.js - Delete content directory and export fresh content
101+
npm run content:update - Delete content directory and export fresh content
102102
103103
Export Command Used: csdx cm:export -k ${SOURCE_API_KEY} -d content
104+
- Export stack used: Red Panda Main Stack
104105
`);
105106
}
106107

version_handler.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,6 @@ async function updateVersionAndTag(type = 'patch') {
186186

187187
// CLI interface
188188
if (require.main === module) {
189-
console.log(process.argv)
190189
const args = process.argv.slice(2);
191190
const command = ['major', 'minor', 'patch'].includes(args[0]) ? 'update' : args[0];
192191

0 commit comments

Comments
 (0)