Git Product home page Git Product logo

symfony-cmf-docs's Introduction

This repository is no longer maintained

Due to lack of interest, we had to decide to discontinue this repository. The CMF project focusses on the Routing component and RoutingBundle, which are still in active use by other projects.

This repository will no longer be upgraded and marked as abandoned, but will be kept available for legacy projects or if somebody wants to experiment with the CMF.

You can contact us in the #symfony_cmf channel of the Symfony devs slack.

Build Status

Symfony CMF Documentation

This is the document of the Symfony Content Management Framework (CMF) and is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License.

This documentation is rendered online at http://symfony.com/doc/master/cmf/index.html

Contributing

Pull requests are welcome. Please see our CONTRIBUTING guide.

Thanks to everyone who has contributed already.

symfony-cmf-docs's People

Contributors

adou600 avatar chanakasan avatar cordoval avatar dantleech avatar dbu avatar egulias avatar eiannone avatar electricmaxxx avatar emmanuelvella avatar felds avatar gonzalovilaseca avatar jdespatis avatar krizon avatar lemoinem avatar lsmith77 avatar nykopol avatar peekmo avatar shieldo avatar simonvanherweghe avatar sofhad avatar sveriger avatar themelter avatar tiagojsag avatar trsteel88 avatar uwej711 avatar wataruoguchi avatar wjzijderveld avatar wouterj avatar xabbuh avatar zuhair-naqvi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

symfony-cmf-docs's Issues

documentation versions on symfony.com

at the hackday in zurich we decided we want to have a documentation version per major release (so 1.0 and master from this summer, 1.0 and 1.1 and master once 1.1 is released...). how can we implement this on symfony.com? can we at all?

the release cycle is not strictly linked to symfony core, and the versions certainly are not (cmf 1.1 will most likely still support symfony 2.3).

/cc @fabpot

Menu

Describes the use of the menu with CMF.

TreeBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

ContentBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

Building a CMS

Describes the steps necessary to build a CMS with CMF and Sonata.

Tutorial - Installing CMF

I'm following the docs from http://symfony-cmf.readthedocs.org/en/latest/tutorials/installing-configuring-cmf.html

There it states to use

"post-install-cmd": [
    "Liip\\VieBundle\\Composer\\ScriptHandler::initSubmodules",
    ...
],
"post-update-cmd": [
    "Liip\\VieBundle\\Composer\\ScriptHandler::initSubmodules",
    ...
]

But after reading the composer.json from https://github.com/symfony-cmf/symfony-cmf and installing the cmf with composer, no Liip bundle appear in my vendor folder, thus not executing those commands.
Is it possible that those commands shouldn't be there? or the composer.json from symfony-cmf to be wrong?
There is no other reference to the LiipBundle in those docs.

Regards,
Eduardo.

Breadcrumb doesn't work well

The breadcrumb doesn't render nice in the CMF docs. For instance, navigating to cmf/bundles/block/introduction, I expect to see:

Home » Documentation » Symfony CMF Documentation » Bundles » BlockBundle » The BlockBundle 

But the actual result is:

Home » Documentation » Symfony CMF Documentation » BlockBundle » The BlockBundle 

Visiting URLs which are only one level deep, for instance getting_started/menu will render only:

Home » Documentation » Symfony CMF Documentation » Menu

I expected:

Home » Documentation » Symfony CMF Documentation » Getting Started » Menu

On the core docs, it all works fine.

/cc @fabpot

Installation guide should be centralized and contain all the available options

Explaining: between your website and symfony's, there are at least 3 installation guides: The one in the cmf.symfony.com home, for the "clean" version, the one in "get started" for the sandbox version, and the complete version for installation on top of an existing symfony 2 installation.

IMO all the info should be compiled in the sf page. The installation guide should be for the clean version, a "start here and follow the next pages" thing, like it's done in the main sf docs.
This page would also contain links to the other two installation instruction sets. Those two versions I suggest storing them as cookbook entries, as one is for demo purposes and the other is for expert users who want to tweak details or get to know the tool's insides.

I'd like your feedback on this before actually starting doing something.

Also, is there some kind of nice editor for .rst files for ubuntu/linux? Gedit is ok, but it would be nice to have something a bit less hardcore, specially for a first timer ;)

Sync with

  • cookbook/installing_configuring_doctrine_phpcr_odm.rst
  • cookbook/installing_configuring_inline_editing.rst
  • cookbook/editions/*

RoutingExtraBundle and Cmf Routing Component

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

Rewriting Routing component docs

Just a simple placeholder to remind me of this after 14 days...

  • Finish the rewrite started in #186 (3 todo comments + the other sections)
  • Split the article in multiple articles (long articles are demotivating): ChainRouter, DynamicRouter, NestedMatcher
  • Document all features included in the component (don't have any "look at the source code" in the article)
  • Document new features
    • Compiler Passes
  • Update RoutingBundle docs to not have duplicated things

MenuBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

license?

do we need a license file here too? and should it be MIT or some creative commons - as this is not code but documentation?

Installation/Configuration

Installation and (less as possible) configuration to get a CMF project running. Further configuration should be handled in the book or reference. Installation guide assumes an combined implementation (of the different CMF bundles).

Should also include subsections for:

  • Installing and configuring with Doctrine PHPCR ODM
  • Installing and configuring with Doctrine DBAL

Doc Consistency aka Standards

As you properbly already know, I love consistency. My main task at the symfony docs is reviewing all incoming PRs and making them ready for merging.
To ease my job, I had put some standards together to make my review task a bit easier.

Some days ago, I got interested by the CMF project. It's a great project as far as I understand it, but one thing made my sad: The documentation. The text is great, but the format is really inconsistent and sometimes incorrect.

With a little bit more effort, I can do some minor reviewing at the PRs here as well, but that means I need to have some standard. From your contributing page, I concluded that you use the Symfony standards.

But looking at the docs, it looks like you don't follow those. For instance, you're breaking around the 100th character, well the docs do that at the 72th character.

With this issue, I want to know if you like it if I'm going to do some review job here and I want to know which standard you use (or better said, which standards you follow and which not).

MultilangContentBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

The big picture

High level Why? Use information of the “Why Symfony2 CMF?” sheets.

BlockBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

Introduction

Documentation overview, directing user to their information.

Blocks

Describes the use of blocks with CMF.

routing component update

update the routing component doc (and routing extra bundle where needed) for the refactoring of NestedMatcher and RouteEnhancers

Routing

Describes the use of routing with CMF.

Content

Describes the use of content with CMF.

CoreBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

TreeBrowserBundle

Includes (but not limited to) dependencies, independent installation, usage, examples, full configuration options. Targets developers with some or a lot of experience with CMF and developers who want to use the bundle independently.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.