Training material metadata

[Justin Mclean <ju...@classsoftware.com>]

Hi,

At ApacheCon we got a question from the audience about metadata and content expiry. I currently put some meta-data in my asciidoc documents. Something like this:
:description: 45 minute talk on the Apache Way and navigating a project through the incubator
:keywords: Apache Way,Incubator
:talk: Navigating the ASF Incubator Process

Some it is use as text substitions in the content and also gets added as metadata to teh header. [2]

Way, way back I use to use this [1] do we want to consider using something like this (or a subset of it)?

At some point we would like to be able to automatically search presentation and other material based on this meta data.

Thanks,
Justin

1. https://www.dublincore.org
2. https://asciidoctor.org/docs/user-manual/#metadata

Re: Training material metadata

[Karl Heinz Marbaise <kh...@gmx.de>]

Hi Justin,

On 25.10.19 20:04, justin@classsoftware.com wrote:
> Hi,
>
>> If a training material has not been updated for a time period longer
>> than year for example it should be marked as "Outdated.”
>
> Yep which can be determined by saving a date of publishing and a guess at when it needs to be updated in metadata.
>
> We might be able to automate some of this if it bases on a released version of software, but we wouldn’t be able to do that for all material (see below).
>
>> "revdate" and "revnumber”.
>
> Not all material is based on a a product version e.g. the current Apache Way and incubator talks.
>
>> Might be different for each material/training.
>
> Very likely.

What about simply make a usage like this:

Having a "revnumber" means this is version based release.

but if no "revnumber" given but a "revdate" this could be used an
indicator to make it differentiable and handle also the thing to be
identifying material being outdated.

More formally:

If "revnumber" is given AND "revdate" is given:

   Product released based things. Also makes it easy
   to have an "outdated" relation. "revdate" will be filled
   with the release date.


If "revnumber" is NOT given AND "revdate" is given:

   not related to a product; for example incubator talks etc.
   but we can define "outdated" if needed. As you mentioned
   can be filled with published date.

>
> Thanks,
> Justin
>


Kind regards
Karl Heinz Marbaise

Re: Training material metadata

[ju...@classsoftware.com]

Hi,

> If a training material has not been updated for a time period longer
> than year for example it should be marked as "Outdated.”

Yep which can be determined by saving a date of publishing and a guess at when it needs to be updated in metadata.

We might be able to automate some of this if it bases on a released version of software, but we wouldn’t be able to do that for all material (see below).

> "revdate" and "revnumber”.

Not all material is based on a a product version e.g. the current Apache Way and incubator talks.

> Might be different for each material/training.

Very likely.

Thanks,
Justin

Re: Training material metadata

[Karl Heinz Marbaise <kh...@gmx.de>]

Hi,

based on the discussion in the audience I think the idea was a little
bit different. Or I missunderstand your comment Justin..?

If a training material has not been updated for a time period longer
than year for example it should be marked as "Outdated.". This could be
shown on a furture website as "Outdated material. Might not be accurate
anymore" as well as showing a kind of a WARNING within the dev-tools.

I would say based on what I know about Asciidoctor this can be simply
achieved by using the following two things:

"revdate" and "revnumber".

With the "revnumber" you have a real thing like a Release and with
"revdate" it could be identified against the current date if it's older
than a year for example. Also searching for material which is older than
a given timepoint could be done.

But based on the above one question arises: When is material defined as
outdated? By which timeperiod? Might be different for each
material/training.

Kind regards
Karl Heinz Marbaise

On 25.10.19 18:13, Justin Mclean wrote:
> Hi,
>
> At ApacheCon we got a question from the audience about metadata and content expiry. I currently put some meta-data in my asciidoc documents. Something like this:
> :description: 45 minute talk on the Apache Way and navigating a project through the incubator
> :keywords: Apache Way,Incubator
> :talk: Navigating the ASF Incubator Process
>
> Some it is use as text substitions in the content and also gets added as metadata to teh header. [2]
>
> Way, way back I use to use this [1] do we want to consider using something like this (or a subset of it)?
>
> At some point we would like to be able to automatically search presentation and other material based on this meta data.
>
> Thanks,
> Justin
>
> 1. https://www.dublincore.org
> 2. https://asciidoctor.org/docs/user-manual/#metadata
>