Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-schranz committed Aug 8, 2024
1 parent 59343ad commit b755a9f
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 14 deletions.
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,10 @@ Execute the following [composer](https://getcomposer.org/) commands to add the b
project:

```bash
composer require "elasticsearch/elasticsearch:7.9.*" # should match version of your elasticsearch installation
composer require sulu/article-bundle
```

Afterwards, visit the [bundle documentation](Resources/doc) to
Afterwards, visit the [bundle documentation](docs) to
find out **how to set up and configure the SuluArticleBundle** to your specific needs.


Expand All @@ -67,18 +66,6 @@ In contrast to Sulu pages, articles are **managed in a flat list** instead of a
the Sulu page tree, the article bundle is **optimized for managing a big number of articles**.


### Elasticsearch dependency

The SuluArticleBundle was originally developed to be used in the publishing industry. To satisfy the initial
requirements regarding performance and scalability, a **view layer stored in an Elasticsearch index** was utilized.
Because of this, there is **no way to use the bundle without Elasticsearch** at the moment. It is planned to
remove this hard dependency in the next major version.

If you cannot or do not want to make Elasticsearch a dependency of your project, you can **use Sulu pages for
certain use cases** instead of the SuluArticleBundle. However, be aware that the article list provides a better
performance and is more comfortable to use with a large number of entities.


## ❤️  Support and Contributions

The Sulu content management system is a **community-driven open source project** backed by various partner companies.
Expand Down
64 changes: 64 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Getting Started

## Installation

The recommended way to install this bundle is through [Composer](https://getcomposer.org/).

```bash
composer require sulu/article-bundle
```

## Create your first template

Go to your `config/templates/articles` directory a new file `article.xml` with the following content:

<details>
<summary>article.xml</summary>

```xml
<?xml version="1.0" ?>
<template xmlns="http://schemas.sulu.io/template/template"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://schemas.sulu.io/template/template http://schemas.sulu.io/template/template.xsd">

<key>article</key>

<view>views/articles/article</view>
<controller>Sulu\Bundle\ContentBundle\Content\UserInterface\Controller\Website\ContentController::indexAction</controller>
<cacheLifetime>604800</cacheLifetime>

<meta>
<title lang="en">Article</title>
<title lang="de">Artikel</title>
</meta>

<properties>
<property name="title" type="text_line" mandatory="true">
<meta>
<title lang="en">Title</title>
<title lang="de">Titel</title>
</meta>

<params>
<param name="headline" value="true"/>
</params>

<tag name="sulu.rlp.part"/>
<tag name="sulu.search.field" role="title"/>
</property>

<property name="url" type="route">
<meta>
<title lang="en">Resourcelocator</title>
<title lang="de">Adresse</title>
</meta>

<tag name="sulu.rlp"/>
<tag name="sulu.search.field" role="url"/>
</property>
</properties>
</template>

```

</details>

0 comments on commit b755a9f

Please sign in to comment.