Skip to content
This repository has been archived by the owner on Jan 22, 2024. It is now read-only.

Suggestion - The Future of Cod: Requirements and Implementations #103

Open
fkaminski opened this issue Aug 28, 2021 · 10 comments
Open

Suggestion - The Future of Cod: Requirements and Implementations #103

fkaminski opened this issue Aug 28, 2021 · 10 comments
Milestone

Comments

@fkaminski
Copy link

fkaminski commented Aug 28, 2021

Since the demo is only meant to show the possibilities so that they can be studied,
it is based exclusively on a pure Contao installation.

Nevertheless, the demo is often compared with external themes.
Due to the orientation of the demo, this is not really useful and is often misunderstood.

It would possibly be much easier (regarding maintenance and expectations) if:

As a suggestion:
Just concentrate on the actual functionality/backend implementation
and use a simple/light layout for the frontend (possibly even similar to the documentation).

@fkaminski
Copy link
Author

fkaminski commented Aug 28, 2021

Perhaps then also with links to the appropriate entries of the documentation ...

@may17 may17 added this to the v2 milestone Aug 28, 2021
@may17
Copy link
Contributor

may17 commented Aug 28, 2021

This is some topic for version two and the people who like to work on it.

@fkaminski
Copy link
Author

fkaminski commented Aug 28, 2021

Brainstorming regarding maintenance effort/implementation.
COD v2 requirements collection for further discussion.

Version management (COD v2 and higher):
Which Contao versions should be supported?
LTS and any above it? Or should only the current Contao version be supported at the start of v2. Possibly with notes from when a new feature was supported in Contao (similar to what we do in the documentation).

Installation:
Do we need a CM capability?
(Or maybe the matching DB dump is enough for installation)?

Backend demo content:
The previous content division fits for the most part. The question remains how detailed e.g. single CE's or for example news lists (with the different templates) should be listed in the future.

Theme (Layout):
With concentration on displaying the Contao functions/features, the actual frontend presentation can be clear/simple/friendly. Possibly this will then lead to no longer (layout) comparisons with other "Themes". At the same time the future maintenance effort of the styling will be reduced.

It doesn't take any special tech to do that either (.css only).
If others exist (sass/scss, less, tailwind etc.) ...?
Since this is not the task of the demo - it would be only goodies which could be versioned / offered here anyway.
(Same possibly regarding workflow presets).

@fkaminski
Copy link
Author

fkaminski commented Aug 28, 2021

Possibly like this quick Mockup :-)

COD-v2-mockup-sample

@may17
Copy link
Contributor

may17 commented Aug 28, 2021

As mentioned on the Contao projects issue for the COD, keep the current licence in mind. Just to let you know if you like to use any of the existing content in the future.

@fkaminski
Copy link
Author

fkaminski commented Aug 29, 2021

As mentioned in #105
I don't know if it would be better to make separate issues for each of the future tasks?
In addition, therefore, allow me to make some (more detailed) comments here.

I think the previous COD task should be kept.
Will say: The Demo should only reflect the Demo Character. Then it doesn't have to compete with external "themes" (or to create the expectation to compete with them). Otherwise, everyone is free to offer their own, free solutions.

Starting from this: Maintenance effort (also regarding installation)
Since the demo is shown on contao.org, we should consider only the current Contao versions.
If one also want to support the LTS in parallel ...
Let me know how you think about the maintenance workflow! (see also #99)

Along with that: Do we need a CM/Extension installation then?
For example, I have locally raised the current COD version to Contao 4.12.1. You can imagine the corresponding procedure.
(If someone of course would be willing to continue to maintain a CM installation ... Why not?)

Otherwise:
The old/previous procedure still works. Import .sql Dumb and copy Data (template/files directory) o. import the .cto..
Regarding the maintenance effort then certainly easier ...

Note I:
Another alternative approach in this context would be: The offered .sql Dumb no longer contains the theme management but only the (demo) content. This then "only" via the .cto (Theme Import).
Advantages would be:

  • The maintenance could be split into these areas
  • The user can decide ...
  • .. to install only demo data for the purpose of BE studying ...
  • ... or to be able to use one (or more 😄 ) available layouts (.cto) based on it.

Note II:
An alternative solution regarding theme handling (also regarding the assets) is available for discussion: contao/contao#2781

Further more: Question regarding the presentation:
My previous remarks regarding the "Demo Character" lead to the fact that one could offer a timeless layout in this respect and thus not have to compete with existing "Themes" or raise corresponding expectations. This could also reduce the future maintenance effort.

@sascha-mueller
Copy link
Contributor

We definitely need to define what the demo should be able to do.
I suspect there are more than enough people who have looked at the demo and compared it to another layout to decide if system A or B is a possibility.

For the supported versions, I see it the other way around. Important I find the LTS, nice the intermediate versions, which always exist only a few months.

I also don't find it an advantage to separate demo content and theme. If necessary, I also want to look in the BE as the theme was built and would have to import that extra.

@fkaminski
Copy link
Author

fkaminski commented Aug 30, 2021

For the supported versions, I see it the other way around. Important I find the LTS, nice the intermediate versions, which always exist only a few months.

If you are willing to maintain two versions, they should correspond to the CM choice (LTS or Newest).

And if you offer the COD for installation via the CM, both these versions should work (see #101 (comment)).
(Than at least for the LTS installation via CM)

See for example the EUF Installation workflow/guide ...
https://erdmann-freunde.de/produkte/contao-themes/optimist/installation/

@fkaminski fkaminski changed the title Suggestion: Emphasize the demo character more in the frontend. Suggestion - The Future of Cod: Brainstorming Requirements and Implementations Aug 30, 2021
@fkaminski fkaminski changed the title Suggestion - The Future of Cod: Brainstorming Requirements and Implementations Suggestion - The Future of Cod: Requirements and Implementations Aug 30, 2021
@fkaminski
Copy link
Author

fkaminski commented Aug 30, 2021

I suspect there are more than enough people who have looked at the demo and compared it to another layout to decide if system A or B is a possibility.

But that's the point.
In my opinion, the demo was not intended to represent this
and should clearly limit this expectation once and for all.

The demo should rather be implemented and seen as a kind of function overview. In other words,
possibly more as a live pendant to the documentation.

Otherwise: You can certainly provide a nice, trendy website as a basis. But this will always be subjectively evaluated and will always lead to requests and comments (as in the past and currently the case). Not to mention the maintenance.

Something like this would then be easier (faster/independent) in my opinion via own solutions to realize instead of the "official" representation.

@fkaminski
Copy link
Author

fkaminski commented Aug 30, 2021

We definitely need to define what the demo should be able to do.

My conclusion at the moment:

A)
You should consider not to show the demo on contao.org anymore (prevent theme comparisons).
For the presentation of the Contao possibilities itself there are already other links on contao.org:

B)
It should be ensured that the demo is installable via the CM for at least the LTS and latest Contao version.
see #106

C)
The demo will be communicated from now on as a tool to easily get demo content and study the basic Contao possibilities (as a quick start/in documentation or videos).

Among other things, you could leave relevant info here:
contao/contao#3237

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

No branches or pull requests

3 participants