t3docs / docker-render-documentation

Render TYPO3 Documentation the official way
https://t3docs.github.io/DRC-The-Docker-Rendering-Container/
20 stars 15 forks source link

Add "Last revised on DATE" to pages where possible #94

Closed marble closed 4 years ago

marble commented 4 years ago

For most pages of a Git repository that info can be retrieved from git log. Let's try that

sypets commented 4 years ago

Good idea. But a lot of pages have gotten minimal updates recently where only a sentence was added or a typo fixed. "Last revised" to me seems to indicate that the entire page was revised. Maybe use "Last change" instead?

marble commented 4 years ago

Yes, having "last updated" was the original goal anyway. But then I considered "file date" as a fallback and wanted to distinguish that. But most probably you're right: File date is probably useless and misleading. So I think having "Last updated DATE" with a link to the commit is the best solution. And just output nothing if we don't have that information.

marble commented 4 years ago

RFC: What do you think? @sypets @DanielSiepmann @benjaminkott

So this is my idea to add the information. Since it is derived from a special commit, I prefer to call it like that:

image

sypets commented 4 years ago

To make it more intuitively understandable for a non-technical audience, I would use:

It might also be possible to remove the link "Commit" and make "Last commit" into a link. I understand it might destroys the harmony of the design but it removes redundancy.

These are minor nitpicks and I think this is good as it is.

The question is, though, what is the goal of this change?

marble commented 4 years ago

About the intention:

DanielSiepmann commented 4 years ago

What I found regarding the tag: Use http-equiv https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta#attr-http-equiv. This can contain http response header. So we could set the last modified info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified. One example would be Wed, 21 Oct 2015 07:28:00 GMT.

We probably should remove the info from http response header then. I guess this can be done by TYPO3 Inc. in nginx configuration.

marble commented 4 years ago

Here are some notes I took while doing research: """ https://www.startpage.com/do/dsearch?query=seo+last+updated+meta+tag https://www.seo-suedwest.de/2808-google-ignoriert-last-updated-meta-tag.html

https://support.google.com/webmasters/answer/79812?hl=de

How To SEO Meta Tags For Google & Other Search Engines in 2020 https://www.hobo-web.co.uk/definitive-guide-to-using-important-meta-tags/

https://ahrefs.com/site-audit

https://www.da-agency.de/service/seo/onpage/meta-tags/

!!! https://wordpress.org/support/topic/how-to-add-last-modified-date-to-meta-description/

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta/name

https://wiki.whatwg.org/wiki/MetaExtensions

When a page uploaded two or more times with the same last-modification date (per dc.modified, dcterms.modified, or article:modified_time metatag), distinguishing different uploads even on the same date can be done with the page-version metatag.

dc.modified Date on which the resource was changed.

It must be accompanied by a <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/"> element.

https://www.dublincore.org/specifications/dublin-core/dc-html/ """

marble commented 4 years ago

Done.

Implemented with Docker container v2.6.1 and theme v4.2.1.

Looks like: grafik

and grafik