Future Of The Cookbook - Githubissues

contao / docs-archive

Contao Documentation

https://docs.contao.org/

Other

42 stars 76 forks source link

Future Of The Cookbook #309

Open bezin opened 9 years ago

bezin commented 9 years ago

Hei there,

I just wanted to check if there are any future plans for the cookbook? I like it and would love to i) extend it and ii) translate some of the german content into english as well. But before I do that, I wanted to check if it is desired or if you already have other plans for the cookbook, @aschempp, @lionel-m, @fiedsch, @all?

aschempp commented 9 years ago

Absolutly, that would be great!

Here's how I see the current books

manual => the user manual (not technical)
cookbook => collection of short tutorials all around Contao. Currently technical, but not necessary limited to that (though we would then need to come up with a clear separation)
api => new API reference guide. I'm currently working on a draft for the summary (what it could contain)
contao4 => everything related to concepts, new API and how to migrate existing extensions (very technical)

fiedsch commented 9 years ago

+1 for @aschempp's outline.

In addition I like the idea of having the "main" (or master or whatever you want to call it) documentation of the technical parts in english as you have to be able to read texts in that language as a developer. Currently is seems we have most documentation in german and some of it translated to german.

What is your opinion on that?

aschempp commented 9 years ago

There is some german content of the cookbook, which was contributed at the Contao Camp in 2013. If someone would translate that, I'm all in for only having that in english.

Be aware that some of the content is meanwhile outdated or no longer best practice, so before someone starts anything we should create issues for each chapter to discuss them.

bezin commented 9 years ago

+1 for the one-issue-per-chapter approach. I would translate that stuff into english afterwards. I agree with @fiedsch that english only should be enough since you have to be familiar with that language anyways, when developing.

+1 for @aschempps' outline as well.

lionel-m commented 9 years ago

I agree with @fiedsch that english only should be enough since you have to be familiar with that language anyways, when developing.

:+1:

aschempp commented 9 years ago

@bezin feel free to start any issue for a topic you want to translate. Pick the one you prefer most to start with ;-)

aschempp commented 9 years ago

Also be aware that there is also a still-unfinished chapter at https://github.com/contao/docs/pull/126. Maybe someone wants to finish and translate that too.

bezin commented 9 years ago

@aschempp I'd start with the Models Chapter. I'll open an issue later today.