Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

[NEW TOC] Tutorials to cookbook #250

Merged
merged 9 commits into from
Sep 12, 2013

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Aug 26, 2013

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets -

This just renamed the files and fixed references, I haven't touched a word.

@@ -133,7 +133,7 @@ choose controllers based on content. See :doc:`../bundles/routing` for
details.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this not be the base of the Installation book chapter rather?

@dbu
Copy link
Member

dbu commented Aug 27, 2013

while i agree with our decision that tutorial was one area too much (even more as its not a step-by-step tutorial but each a piece of its own) i wonder if we can not move the installation tutorials to the book and maybe too specific information into bundle sections.

handling_multilang_documents.rst should be a book chapter imho, as for phpcr-odm and the cmf, multilang is a core feature and not some lesser add-on. the code follows this, so the doc could also emphasize it. i did not realize when looking at your TOC proposal, sorry.
it should be a book chapter explaining everything related to multilanguage and the cmf, i think handling_multilang_documents.rst would be a good starting point for that.

is there a way to have redirects from moved pages for a while? i am afraid of people having old links from blog posts, README and other files we overlooked, tweets and emails and so on... leaving placeholder files would work, but makes it harder to maintain the doc.

@dbu
Copy link
Member

dbu commented Aug 31, 2013

ping

@wouterj
Copy link
Member Author

wouterj commented Sep 1, 2013

wonder if we can not move the installation tutorials to the book and maybe too specific information into bundle sections.

Sure, some articles should be removed in favor of new articles and some other concepts should be moved. But I'm -1 for moving the installation tutorials to the book. IMO, the book should provide one way, the default way, of building an application. In this case, readers want to have a fully working CMS, build from scratch using the things learned in the book.

But a better look at the articles revealed indeed pretty much info that should be placed inside other sections. We may even have no more articles in the cookbook. I'll investigate some time in that, maybe I drop the entire cookbook section.

handling_multilang_documents.rst should be a book chapter imho, as for phpcr-odm and the cmf, multilang is a core feature and not some lesser add-on. the code follows this, so the doc could also emphasize it.

+1

is there a way to have redirects from moved pages for a while?

In the core docs, we have a redirection_map file with all the redirections maps. I don't know if it is possible to do the same thing with the CMF docs. /cc @fabpot

@lsmith77
Copy link
Member

lsmith77 commented Sep 1, 2013

btw .. this PR needs a rebase

@dbu
Copy link
Member

dbu commented Sep 1, 2013

ok, convinced for moving the install tutorials to cookbook entries.

can we move the multilang thing to a book chapter instead then?

for the rest i am fine with the PR then, but would love to have the
redirects if we can, that would really be useful.

@wouterj
Copy link
Member Author

wouterj commented Sep 2, 2013

Ok, the articles in the current cookbook and what I think must be done with them:

  • choosing_a_storage_layer - keep it, in section 'Database'
  • installing_cmf_sandbox - keep it, in section '...' (how are we going to call this section? Installation, Bootstrap, ...?)
  • installing_cmf_core - keep it, in section '...' (see above)
  • installing_configuring_doctrine_phpcr_odm - move to book/phpcr and book/installation ( Create "Database Layer" article #242 )
  • installing_configuring_inline_editing - move to book/editing ( Create "Editing" article #239 )
  • creating_cms_using_cmf_and_sonata - move to book/editing ( Create "Editing" article #239 )
  • using_blockbundle_and_contentbundle - move to bundle docs
  • handling_multilang_documents - move to book/mutlilang ( Create "Multilanguage" book chapter #257 )
  • phpcr_odm_custom_documentclass_mapper - move to Doctrine PHPCR docs, or keep it in section 'Database'
  • using_a_custom_route_repository - move to article in bundle docs

wdyt @dbu ?

@dbu
Copy link
Member

dbu commented Sep 3, 2013

yeah, i agree with that plan. can you do that in this PR wouter?

@fabpot: how can we redirect urls in the cmf docs? @wouterj mentioned a redirection_map file in the symfony-docs - would we need to add to that file, or can we do our own such file?

@wouterj
Copy link
Member Author

wouterj commented Sep 12, 2013

@dbu I think this can get merged

dbu added a commit that referenced this pull request Sep 12, 2013
@dbu dbu merged commit a28ab4d into symfony-cmf:master Sep 12, 2013
@dbu
Copy link
Member

dbu commented Sep 12, 2013

alright, here we go. will get a ton of 404 on the docs now.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants