Skip to content

Commit 2eb3dff

Browse files
fgatti675fgatti675
committed
Doc updates
1 parent fedcb0d commit 2eb3dff

File tree

23 files changed

+116
-37
lines changed

23 files changed

+116
-37
lines changed

‎CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
## [3.0.0-beta.6] - 2024-04-23
2+
3+
- Added AppCheck to every FireCMS variant.
4+
- Various fixes for datasource delegate.
5+
- Fix in saving cleaned data.
6+
- Cloud new user roles creation issue fixed.
7+
- Error message display issue in table cells fixed.
8+
- Subcollections updating issue fixed.
9+
- Import/export analytics and related data mapping conversions updated.
10+
- Updated and improved handling of user roles and permissions.
11+
- Enhanced the handling of service account files and project creation using SA.
12+
- Updated the behavior of unindexed queries.
13+
- User management connection to demo removed.
14+
- Dependency updates to mitigate security issues.
15+
- Exposing additional methods from data inference for better customization.
16+
- Pro template updates for improved UI/UX.
17+
- Updated documentation for collections and user management.
18+
119
## [3.0.0-beta.5] - 2024-04-01
220

321
- [BREAKING] The main component for FireCMS Cloud has been renamed from `FireCMSApp` to `FireCMSCloudApp`. Please update

‎examples/example_pro/src/FirestoreApp/App.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ function App() {
119119
const appCheckResult = useAppCheck({
120120
firebaseApp,
121121
options: {
122-
provider: new ReCaptchaEnterpriseProvider(process.env.VITE_RECAPTCHA_SITE_KEY as string)
122+
provider: new ReCaptchaEnterpriseProvider(import.meta.env.VITE_RECAPTCHA_SITE_KEY as string)
123123
}
124124
});
125125

‎packages/cli/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@
7070
"node_modules",
7171
"template/node_modules"
7272
],
73-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
73+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
7474
}

‎packages/cli/templates/template_cloud/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## FireCMS Cloud starter template
2+
3+
Welcome to FireCMS Cloud!
4+
5+
In order to run this project, you will need to create a FireCMS Cloud project
6+
in the [FireCMS Cloud](https://app.firecms.co).
7+
8+
Then simply run:
9+
10+
### Running the project
11+
12+
Install the dependencies:
13+
14+
```bash
15+
yarn
16+
```
17+
18+
And run the project locally:
19+
```bash
20+
yarn dev
21+
```
22+
23+
All your collections generated in the FireCMS Cloud will be available in your
24+
local development environment.
25+
26+
### Deploying the project
27+
28+
All the configuration is already set up for you. You just need to run:
29+
30+
```bash
31+
yarn deploy
32+
```
33+

‎packages/cli/templates/template_pro/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## FireCMS starter template
1+
## FireCMS PRO starter template
22

33
Welcome to FireCMS!
44

‎packages/collection_editor/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,5 @@
8181
"publishConfig": {
8282
"access": "public"
8383
},
84-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
84+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
8585
}

‎packages/collection_editor_firebase/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,5 @@
6868
"react-app/jest"
6969
]
7070
},
71-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
71+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
7272
}

‎packages/create_firecms_app/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@
3838
"exclude": [
3939
"node_modules"
4040
],
41-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
41+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
4242
}

‎packages/data_enhancement/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@
9191
"publishConfig": {
9292
"access": "public"
9393
},
94-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
94+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
9595
}

‎packages/data_import_export/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@
101101
"publishConfig": {
102102
"access": "public"
103103
},
104-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
104+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
105105
}

‎packages/editor/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@
6262
"typescript": "^5.4.5",
6363
"vite": "^5.2.9"
6464
},
65-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
65+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
6666
}

‎packages/firebase_firecms/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,5 @@
6363
"react-app/jest"
6464
]
6565
},
66-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
66+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
6767
}

‎packages/firecms/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@
3737
"exclude": [
3838
"node_modules"
3939
],
40-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
40+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
4141
}

‎packages/firecms_cloud/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,5 @@
8181
"react-app/jest"
8282
]
8383
},
84-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
84+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
8585
}

‎packages/firecms_core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
"dist",
119119
"src"
120120
],
121-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e",
121+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df",
122122
"publishConfig": {
123123
"access": "public"
124124
}

‎packages/formex/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,5 @@
6868
"react-app/jest"
6969
]
7070
},
71-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
71+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
7272
}

‎packages/mongodb/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@
4646
"react-app/jest"
4747
]
4848
},
49-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
49+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
5050
}

‎packages/schema_inference/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@
3030
"build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
3131
"clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
3232
},
33-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
33+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
3434
}

‎packages/ui/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
"src",
117117
"tailwind.config.js"
118118
],
119-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e",
119+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df",
120120
"publishConfig": {
121121
"access": "public"
122122
}

‎packages/user_management/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@
7070
"react-app/jest"
7171
]
7272
},
73-
"gitHead": "d6a2f28e93d3c532dd6efacfccffb91383d5330e"
73+
"gitHead": "fedcb0d43c504245dd76b702e4ab4479fa8592df"
7474
}

‎website/docs/pro/sample_pro.mdx

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,35 @@ const {
2727
```
2828
This snippet sets up Firebase, checks for loading status, and handles configuration errors, ensuring a smooth setup process.
2929

30-
### Collection Configuration
30+
### Collection Configuration Plugin
3131

32-
The flexibility to configure collections directly within Firestore allows for dynamic content structure management.
32+
The collection editor plugin allows you to include a UI for editing collection configurations. You can choose where
33+
the config is stored, and pass the configuration to the plugin. We include a controller that saves the configuration
34+
in your Firestore database. The default path is `__FIRECMS/config/collections`.
35+
36+
The controller includes a few methods you can use in your own components to manage the collection configuration.
3337

3438
```jsx
3539
const collectionConfigController = useFirestoreCollectionsConfigController({
3640
firebaseApp
3741
});
3842
```
39-
Using `useFirestoreCollectionsConfigController`, developers can adjust collection configurations in real-time, enhancing CMS flexibility.
43+
44+
You are free to define your collections in code, or use the UI to define them. You can also allow the modification in
45+
the UI of the collections defined in code. You can then merge the collections defined in code with the ones defined in
46+
the UI.
47+
```jsx
48+
const collectionsBuilder = useCallback(() => {
49+
// Here we define a sample collection in code.
50+
const collections = [
51+
productsCollection
52+
// Your collections here
53+
];
54+
// You can merge collections defined in the collection editor (UI) with your own collections
55+
return mergeCollections(collections, collectionConfigController.collections ?? []);
56+
}, [collectionConfigController.collections]);
57+
```
58+
4059
4160
### Authentication Management
4261
@@ -52,20 +71,7 @@ const authController: FirebaseAuthController = useFirebaseAuthController({
5271
```
5372
This code sets up authentication with custom sign-in options and integrates with a user management system for role definition.
5473
55-
## Collections and Custom Views
56-
57-
Developers can define collections and views, merging predefined ones with those from the UI for a tailored content management experience.
58-
59-
```jsx
60-
const collectionsBuilder = useCallback(() => {
61-
return mergeCollections([productsCollection], collectionConfigController.collections ?? []);
62-
}, [collectionConfigController.collections]);
63-
```
64-
`mergeCollections` combines code-defined collections with UI-configured ones, enriching the CMS structure.
65-
66-
## Controllers and Persistence
6774
68-
Important for managing user preferences and navigating the CMS efficiently.
6975
7076
### Mode Controller & User Config Persistence
7177

‎website/sidebars.js

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,21 @@ module.exports = {
2222
"label": "FireCMS PRO",
2323
"collapsed": false,
2424
"items": [
25-
"pro/pro_quickstart",
26-
"pro/sample_pro",
25+
{
26+
type: 'doc',
27+
id: "pro/pro_quickstart",
28+
label: "Pro Quickstart",
29+
className: "pro-sidebar-item"
30+
},
31+
{
32+
type: 'doc',
33+
id: "pro/sample_pro",
34+
label: "Main concepts",
35+
className: "pro-sidebar-item"
36+
},
37+
"firebase_setup",
2738
]
2839
},
29-
"firebase_setup",
3040
{
3141
"type": "category",
3242
"label": "Collections",

‎website/src/css/custom.css

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ h1, .h1, h2, .h2, h3, .h3, h4, .h4 {
2626
font-weight: 600 !important;
2727
}
2828

29+
.pro-sidebar-item :before{
30+
content: "PRO";
31+
margin-right: 16px;
32+
text-transform: uppercase;
33+
font-size: 0.75rem;
34+
font-weight: 500;
35+
width: fit-content;
36+
color: transparent;
37+
background-clip: text;
38+
background-image: linear-gradient(to right, rgb(236, 76, 81), rgb(149, 67, 193), rgb(98 85 250));
39+
}
40+
2941
.gradient-text {
3042
font-weight: 500;
3143
width: fit-content;

0 commit comments

Comments
 (0)