This repository has been archived by the owner on Apr 17, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat(Docs): Enable Read the docs with mkdocs integration * docs(Docs): Adds about, index and license page * docs(Docs): Removing License File in docs, adding description to the index.md. * docs(Docs): Changes Demo section to Guideline section
- Loading branch information
Showing
4 changed files
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# About | ||
|
||
## Comming Soon! |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Contenta CMS | ||
|
||
Contenta is an API-First Drupal distribution. It's all about the content. Learn more at http://contentacms.org. | ||
|
||
## [](#goals)Goals | ||
One of the conclusions of DrupalCon Baltimore was that Drupal 8 has **impressive tools to build a decoupled application**. However, assembling all the tools together and setting them up correctly can be a little bit daunting. On top of that, once you have everything set up you need to figure out the ins and outs of your front-end project. | ||
|
||
With this in mind, Contenta CMS is born to _make your content happy_. Contenta CMS is the response of **the community** to build an API-First Drupal distribution. The goals of Contenta are simple: provide a standard platform that is API ready along with demo content and example front-end applications. In summary, Contenta intends to ease the pain of using, or simply trying, decoupled Drupal. | ||
|
||
## [](#demos)Demos | ||
An integral part of Contenta is to provide an out of the box content model and demo content ready for you to start working with it. The demo chosen by the community is a [recipe magazine](https://www.drupal.org/node/2818741). | ||
|
||
With this in mind, every demo consumer will implement this recipe magazine site with the goal in mind to compare the different implementations. | ||
|
||
### [](#example-front-ends)Example Consumers | ||
|
||
Choosing your own front-end technology is one of common reasons to choose a decoupled approach. In a decoupled architecture you can also have multiple front-ends at the same time. Contenta gives you examples on how to build a consumer application in different technologies. | ||
|
||
We will implement the [same wireframes](https://www.drupal.org/node/2818741#comment-12122841) as the Out of the Box Initiative, so all the demo applications can be compared. Even though all applications will have the same structure, each one will choose their look and feel. Angular may use [material design](https://material.io/guidelines/material-design/introduction.html), elm may use [bootstrap](http://getbootstrap.com/), etc. | ||
|
||
| Front-end | Status | Example | Code | | ||
|:----------|:-------------|:--------|:-------| | ||
| Angular | Running demo | [Website](https://contenta-angular.firebaseapp.com/) | [Repo](https://github.com/contentacms/contenta_angular) | | ||
| Elm | Running demo | [Website](https://contenta-elm.firebaseapp.com/) | [Repo](https://github.com/contentacms/contenta_jsonapi__elm) | | ||
| Ember | Need help | Not yet | [Repo](https://github.com/contentacms/contenta_ember) | | ||
| Ionic | Running demo | Not yet | [Repo](https://github.com/contentacms/contenta_ionic) | | ||
| React | In progress | Not yet | [Repo](https://github.com/contentacms/contenta_react) | | ||
| Vue.js + Nuxt.js | In progress | [Website](https://contentavuenuxt.now.sh) | [Repo](https://github.com/contentacms/contenta_vue_nuxt) | | ||
| Chatbot | Running demo | [Blog post](https://medium.com/@dawehner/im-hungry-but-i-can-t-decide-a-small-chatbot-based-upon-contenta-cms-9f8c0bb1d48f) | [Repo](https://github.com/contentacms/contenta-bot) | | ||
|
||
If you want to contribute to any of the demo apps above or add a new one, join [the Slack channel](https://drupal.slack.com/messages/C5A70F7D1) and become part of the project! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Site Information | ||
site_name: Contenta CMS | ||
repo_url: https://github.com/contentacms/contenta_jsonapi/ | ||
repo_name: contentacms/contenta_jsonapi | ||
site_description: Contenta CMS Documentation | ||
docs_dir: docs | ||
site_favicon: favicon.ico | ||
|
||
# Site Structure | ||
pages: | ||
- Home: index.md | ||
- Development: development.md | ||
- Guidelines: | ||
- 'Consumers Implementation Guidelines': demos-consumers-implementation-guidelines.md | ||
- About: about.md | ||
|
||
# Site Configuration | ||
theme: readthedocs | ||
markdown_extensions: | ||
- smarty | ||
- toc: | ||
permalink: True | ||
- sane_lists | ||
- nl2br | ||
- codehilite: | ||
linenums: True | ||
- wikilinks | ||
- abbr | ||
- attr_list | ||
- def_list | ||
- tables | ||
- footnotes |