Information about LTS, ELTS (e.g. show status for version of page you are currently reading) about sphinx_typo3_theme HOT 5 CLOSED

This topic is discussed currently in the marketing slack channel, closely related to the recently introduced TYPO3 documentation icon set. I post in here the current state of the discussion: The idea is to use an icon as indicator of LTS / ELTS / No Support of the current documentation version.

Alexander Nitsche 2 months ago
hi marketing team,

dropping the idea here for the designers of the new icon set: would be nice to have a unique icon for each TYPO3 LTS release whose overall appearance clearly differs from the ones of other releases (in color and maybe also in shape) and to have that icon in three variants:

Variant 1: This TYPO3 release is supported by LTS
Variant 2: This TYPO3 release is supported by ELTS only
Variant 3: This TYPO3 release is not supported anymore

and for two publishing channels:

Large scale: Symbol with many details for being displayed large scaled, e.g. on documentation pages, presentation slides, etc.
Small scale: Symbol with very few details for being displayed small scaled, e.g. in badges in README files.

one use case would be to place it somewhere in the content or frame of the TYPO3 documentation manuals, and having it linked to an appropriate central page that explains all three modes and advises the reader on the next steps. other use cases would be branding branding branding 🙂 (edited)

Markus Schwarz 1 month ago
Well, yes, sounds like a good idea. I just wouldn't make the icons stand out too much from each other, it should be consistent somewhere. Maybe the version number should be integrated to differentiate. Can think about it when I find the time.

Alexander Nitsche 1 month ago
distinguishing the icons just by the release number would probably fail to serve the purpose to immediately make the user aware of the typo3 context s:he is currently in. especially for the small scaled icons.

Fabian Stein 1 month ago
Hi Guys, sorry i was on vacation the last time. I like the idea very much as well. @alexandernitsche do you have access to the Jira? Maybe we could make some tickets out of it to clearify the specific requirements?

Alexander Nitsche 1 month ago
hi fabian, no, i have no access to jira. not sure what the best approach is as markus also wanted to make up his mind on it ..

Markus Schwarz 1 month ago
@FabianStein let's stick to the process, that's best I think (making jira tickets and discuss the request in the team meeting)

Luisa Faßbender 1 month ago
Sorry for my late reply, but I’m honestly not really sure about this. Are you talking about 3 different logo variations for each LTS release or three variants in general?

Alexander Nitsche 29 days ago
let's stick to the process, that's best I think (making jira tickets and discuss the request in the team meeting)
ok, who will create those tickets? should i ask for jira access?

Alexander Nitsche 22 days ago
hi guys, how to proceed here? is anything to be prepared for your next team meeting?

Markus Schwarz 20 days ago
Hey Alexander, I think we'll discuss this in our next designteam meeting, no need for preparing anything. We will decide then how to proceed and get back to you, right @FabianStein? (edited)

from sphinx_typo3_theme.

I also made a suggestion to separate "latest" (latest release) and "master" (unreleased version, identical with core master): TYPO3-Documentation/T3DocTeam#133

If this change is made, it might be a good idea to consider that other change as well.

from sphinx_typo3_theme.

Low priority, closing to declutter issues.

from sphinx_typo3_theme.

The main problem whith this topic is that there needs to be some kind of "authority" (people, convention, database, mandatory list) that defines which manual should have which banner. Could be included via server side includes, for example.

To make provisions in the theme comes second.

However, there is an easy "hack" which has been tried and works very well: Add an infobox in Includes.rst.txt. To our surprise this has turned out to work very well. Example:

See https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/blob/10.4/Documentation/Includes.rst.txt?plain=1

Now each page starts with this 'attention' message:

On the pro side is, that it's up to the editors to add that note.
The downside is, that it will probably be used inconsistently.

I'll close the issue (for now) (again).

from sphinx_typo3_theme.

I think the way it is now is already quite good. The banner about ELTS etc. is displayed for some time now.

from sphinx_typo3_theme.