update source config

Author: frankpagan

.github/FUNDING.yml

@@ -1,4 +1,3 @@
 # These are supported funding model platforms
 
 github: CoCreate-app
-

.github/workflows/automation.yml

@@ -2,8 +2,14 @@ name: CI
 
 on:
   push:
+    branches:
+    - master
   pull_request:
+    branches:
+    - master
   create:
+    branches:
+    - master
 
 jobs:
   updateKeyword:
@@ -12,18 +18,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-  # overwrite description and keyworkds
       - name: Jaid/action-sync-node-meta
         uses: jaid/action-sync-node-meta@v1.4.0
         with:
           direction: overwrite-github # default is overwrite-file
           githubToken: ${{ secrets.GITHUB }}
+  
   ci:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-  # Auto Changog generator
+
       - name: Semantic Release
         uses: cycjimmy/semantic-release-action@v2
         with:
@@ -36,45 +42,13 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}  # Auto Changog generator
-        
-        
-        
 
-  cdn:
+  docs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-          
-      - run: yarn install --frozen-lockfile
-      - run: yarn build
-
-      - uses: CoCreate-app/CoCreate-s3@master
-        with:
-          aws-key-id: ${{ secrets.AWSACCESSKEYID }}
-          aws-access-key: ${{ secrets.AWSSECERTACCESSKEY }}
-          source: './dist/CoCreate-docs.min.js'
-      
-
 
       - name: update documentation
-        run: npm run docs
-
-
-
-  #     - name: setup nodejs
-  #       uses: actions/setup-node@v2
-  #       with:
-  #         node-version: 'v14.15.4'
-            # debuging action
-      # - name: Setup tmate session
-        # uses: mxschmitt/action-tmate@v3
-      # - name: build production version
-
-
-      # - name: upload to s3
-      #   run: npm run s3 
-      #   env:
-      #     AWSKEYID: ${{ secrets.AWSKEYID }}
-      #     AWSACCESSKEY: ${{ secrets.AWSACCESSKEY }}
-      #     DIST_FILE_NAME: './dist/CoCreate-styles.min.js'
+        uses: CoCreate-app/CoCreate-docs@master
+          

.gitignore

@@ -1 +1,2 @@
 # ignore
+node_modules

CONTRIBUTING.md

@@ -11,25 +11,24 @@ In the examples below, substitute your Github username for `contributor` in URLs
 Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-docs) and check out your copy.
 
 ```
-git clone https://github.com/contributor/CoCreate-docs.git
+git docs https://github.com/contributor/CoCreate-docs.git
 cd CoCreate-docs
 git remote add upstream https://github.com/CoCreate-app/CoCreate-docs.git
 ```
 
 ## Create a Topic Branch
 
-Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix on dev branch.
 
 ```
-git checkout master
-git pull upstream master
+git checkout dev
+git pull upstream dev
 git checkout -b my-feature-branch
 ```
 
 ## Write Tests
 
 Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
-Add to [spec](spec).
 
 We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
 
@@ -41,11 +40,6 @@ Implement your feature or bug fix.
 
 Document any external behavior in the [README](README.md).
 
-## Update Changelog
-
-Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
-Make it look like every other line, including your name and link to your Github account.
-
 ## Commit Changes
 
 Make sure git knows your name and email address:
@@ -55,13 +49,24 @@ git config --global user.name "Your Name"
 git config --global user.email "contributor@example.com"
 ```
 
-Writing good commit logs is important. A commit log should describe what changed and why.
+We use [semantic-release](https://github.com/semantic-release/semantic-release) as process to generate changelog
+and to release. Write meaningful commits according to 
+[Commit Message Formats](https://github.com/semantic-release/semantic-release#commit-message-format) is important.
 
 ```
 git add ...
-git commit
+git commit -am "commit-type(optional topic): a meaningful message"
 ```
 
+Here is an example of the release type that should be done based on a [semantic-release](https://github.com/semantic-release/semantic-release):
+
+| Commit message                                                                                                                                                                                   | Release type               |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
+| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | Patch Release              |
+| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release  |
+| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
+
+
 ## Push
 
 ```
@@ -75,36 +80,17 @@ Click the 'Pull Request' button and fill out the form. Pull requests are usually
 
 ## Rebase
 
-If you've been working on a change for a while, rebase with upstream/master.
+If you've been working on a change for a while, rebase with upstream/dev.
 
 ```
 git fetch upstream
-git rebase upstream/master
+git rebase upstream/dev
 git push origin my-feature-branch -f
 ```
 
-## Update CHANGELOG Again
-
-Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
-
-```
-* [#123](https://github.com/CoCreate-app/CoCreate-industry/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
-```
-
-Amend your previous commit and force push the changes.
-
-```
-git commit --amend
-git push origin my-feature-branch -f
-```
-
-## Check on Your Pull Request
-
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
-
 ## Be Patient
 
-It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang in there!
 
 ## Thank You
 

CoCreate.config.js

@@ -11,8 +11,8 @@ module.exports = {
             path: "./test_files/test.html",
             collection: "static_html",
             document_id: "5f08bf3da588c11bf8ead4b3",
+            key: "html",
             data:{
-                name: "html",
                 description:"test descrition"
             }
         },
@@ -23,8 +23,6 @@ module.exports = {
             collection: "test",
             document_id: "6010e012f80ce138be7eed01",
             data:{
-                // collection: "test",
-                // document_id: "",
                 domains: ["cocreate.app"],
                 route: "/docs/boilerplate",
             }

README.md

@@ -1,16 +1,14 @@
 # CoCreate-docs
-Document generator. Easy configuration using data-attributes and highly styleable.
-
+A simple docs component in vanilla javascript. Easily configured using HTML5 data-attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/docs)
 
 ![GitHub file size in bytes](https://img.shields.io/github/size/CoCreate-app/CoCreate-docs/dist/CoCreate-docs.min.js?label=minified%20size&style=for-the-badge) 
-![GitHub package.json version](https://img.shields.io/github/package-json/v/CoCreate-app/CoCreate-docs?style=for-the-badge)
+![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-docs?style=for-the-badge)
 ![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-docs?style=for-the-badge) 
 ![GitHub labels](https://img.shields.io/github/labels/CoCreate-app/CoCreate-docs/help%20wanted?style=for-the-badge)
 
-
 ![CoCreate](https://cdn.cocreate.app/logo.png)
 
-[CoCreate Docs](https://cocreate.app/documentation/CoCreate-docs)
+[CoCreate Docs](https://cocreate.app/docs/docs)
 
 
 We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/Realtime_Admin_CRM_and_CMS/issues) and [pull requests](https://github.com/CoCreate-app/Realtime_Admin_CRM_and_CMS/pulls) or merely upvote or comment on existing issues or pull requests.
@@ -53,3 +51,4 @@ We encourage contribution to our libraries (you might even score some nifty swag
 
 # License
 [The MIT License (MIT)](https://github.com/CoCreate-app/CoCreate-docs/blob/master/LICENSE)
+

src/index.js

@@ -69,16 +69,17 @@ if (crud) {
  * Store html files by config sources
  **/
 if (sources) {
-	sources.forEach(({path, collection, document_id, data}) => {
+	sources.forEach(({path, collection, document_id, key, data}) => {
 		if (!path) return;
 
 		let content = fs.readFileSync(path, 'utf8');
-		const {name, ...rest} = data;
 
-		if (content && name && collection) {
+		if (content && key && collection) {
+			if (!data) data = {};
+			
 			let storeData = {
-				[name]: content,
-				...rest
+				[key]: content,
+				...data
 			};
 			if (!document_id) {
 				CoCreateCreateDocument({