Add tag descriptions

[mjamescompton]

Summary

Generate and include tag description

Why do we need this?

To improve SEO the tag landing pages need to have a description explaining them.

What is already there? What do you see now?

All Sensors, IPCode, Frequency plans have a tag page generated, if they are defined by a device.

What is missing? What do you want to see?

• Create content for all tags. @anastasiagramm
• Add additional fields as tags. @mjamescompton
• Include tag description, either within the schema or this can be Hugo data @johanstokking what do you recommend?
• Display field on tag pages. @mjamescompton

How do you propose to implement this?

@anastasiagramm Could you work on the content for the tags, I have generated a google sheet

https://docs.google.com/spreadsheets/d/1OC-bcU5a8ydJBKBt0QELO-MqzgA7nhoEoGSTFMZ4hvM/edit?usp=sharing

Can you fill in the descriptions here, there is a separate table for Sensors, IPCode, Frequency plans. I have included all the allowed fields from device schema

https://github.com/TheThingsNetwork/lorawan-devices/blob/master/lib/draft/schema.json

so they should all be there and we can add new tables if we include any new fields. A small warning I will not read the descriptions so please make sure they are correct in this doc.

Can you do this yourself and submit a Pull Request?

yes

[mjamescompton]

@anastasiagramm I have also added a field at the bottom of each page for a general description of the tag category Sensors, IPCode, Frequency plans

[mjamescompton]

I've added LoRaWan version and Regional Parameters and a few others which are less important, if you can start with the ones above first and LoRaWan version and Regional Parameters, ignore the others for now.

[johanstokking]

• Include tag description, either within the schema or this can be Hugo data @johanstokking what do you recommend?

We can't really put it in the schema because JSON schema doesn't support descriptions for enum values.

I think that a data file would be helpful. I'm okay with checking that in at https://github.com/lorawan-schema/draft-devices. It can be validated against the schema.

{
  "sensors": {
    "temperature": {
      "description": "Temperature"
    },
    ...
  },
  "ipCodes": {
    "IP68": ...
  },
  ...
}

[anastasiagramm]

@mjamescompton I've filled in the descriptions that you mentioned. please let me know when you need the other ones

[mjamescompton]

@laurensslats Can you review the descriptions

My feedback is that these will be user facing descriptions, shown under the page name https://www.thethingsnetwork.org/device-repository/tags/accelerometer/, and these seem more like meta descriptions which could also be used but maybe we need a user facing one as well

It might be nice if we define a structure such as

All LoRaWAN devices that contain ${SENSOR_NAME}. ${SENSOR_NAME} will record ...... data . This can be useful in ${USECASE} .....

?

[NicolasMrad]

is this still relevant?

[mjamescompton]

@NicolasMrad yes