feat: dataset series section is added

[Kate-Lyndegaard]

No description provided.

[JohannaOtt]

Do new pages also need to be added/linked from somewhere or the like so that it gets displayed at the right place of the documentation at all?
Or is that automatically happen once the file is available in the respective folder?

[JohannaOtt]

Maybe add a short sentence that this section is only displayed in case the dataset is a dataset series/belongs to a series enabled theme?

[Kate-Lyndegaard]

@JohannaOtt Could you please provide the DE translations of this sentence here? I would really like to minimize the back-and-forth on some of these PRs.

"The Dataset series section is displayed only for datasets that have dataset series enabled in the theme."

[JohannaOtt]

Der «Datensatz-Reihe»-Bereich wird nur für Datensätze angezeigt, die zu Themen gehören, für die Datensatz-Reihe aktiviert ist.

[JohannaOtt]

language: en -> language: de ?

[JohannaOtt]

Jeden Datensatz bietet einen Überblick --> Jeder Datensatz bietet einen Überblick
zum enthaltenen Datensatz, seiner Datendatei --> zum enthaltenen Datensatz, seiner Datei oder Dateien

[Kate-Lyndegaard]

Do new pages also need to be added/linked from somewhere or the like so that it gets displayed at the right place of the documentation at all? Or is that automatically happen once the file is available in the respective folder?

@morch23mj How can we select where newly added files appear in the group of files in a section?

[morch23mj]

@morch23mj How can we select where newly added files appear in the group of files in a section?

@Kate-Lyndegaard At least from what I see now, there is this sidebar_position attribute used in each file's head section.

For instance:

---
title: "Übersicht"
...
...
...
language: de
sidebar_position: 0 <--------- THIS ONE

---

Im &laquo;Übersicht&raquo;-Bereich werden allgemeine Eigenschaften und Einstellungen zum Datensatz angezeigt.

That could be used for new files, or sidebar.js file could be used to have a static list of files and their order, like we do for FAQ items.

[Kate-Lyndegaard]

At least from what I see now, there is this sidebar_position attribute used in each file's head section.

Thank you, @morch23mj

[morch23mj]

@Kate-Lyndegaard since positions were changed in en, worth checking if they match those of other locales de and cs

[Kate-Lyndegaard]

@morch23mj There are no sidebar_position attributes in the cz files. Also, I am not sure we are updating their documentation..

@stempler How do we handle updates to the documentation for NAKIT?

[JohannaOtt]

LGTM

[JohannaOtt]

Will not check in detail if these numbers make sense. We will see if they display as expected once the updated website is deployed.

[Kate-Lyndegaard]

@JohannaOtt I'm running the website locally. It looks like this, any thoughts?

[JohannaOtt]

Looks good as the order is the same as on the platform

But I realised that the sections Monitoring and History are missing. Wouldn't it make sense to add those as well now so that it is complete?

Also, on the platform it is "Access controls", not "Access control".

[Kate-Lyndegaard]

@JohannaOtt I will add the Monitoring section in a new and separate PR. There I can also fix the "Access controls". The History section is not on production, because it is not functional so I will not add that for the time being.

[Kate-Lyndegaard]

@morch23mj Do you know why the build is failing? I can't see anything wrong with the document reference it's failing on.

[morch23mj]

@Kate-Lyndegaard build reports:

Error: Docs markdown link couldn't be resolved: (../../create-manage-datasets/create-dataset-series/2014-01-01-dataset-series.md) in "/home/runner/work/hc-documentation/hc-documentation/docs/references/data/2018-03-07-reference-data-dataset-series.md" for version current

Could you quickly check locally if the linked document (../../create-manage-datasets/create-dataset-series/2014-01-01-dataset-series.md) is accessible from the page (hc-documentation/docs/references/data/2018-03-07-reference-data-dataset-series.md)?

No initial thoughts, I can't spot the error, since this is also done in other documents similarly. I can also run this locally later and try to fix it.

As for NAKIT, I recall they gave us the translated documents and we just put them there, so might be we don't need to update those.
The attribute that's missing, as effect, has the documents unordered under the cs locale.

[Kate-Lyndegaard]

@Kate-Lyndegaard build reports:

Error: Docs markdown link couldn't be resolved: (../../create-manage-datasets/create-dataset-series/2014-01-01-dataset-series.md) in "/home/runner/work/hc-documentation/hc-documentation/docs/references/data/2018-03-07-reference-data-dataset-series.md" for version current

Could you quickly check locally if the linked document (../../create-manage-datasets/create-dataset-series/2014-01-01-dataset-series.md) is accessible from the page (hc-documentation/docs/references/data/2018-03-07-reference-data-dataset-series.md)?

No initial thoughts, I can't spot the error, since this is also done in other documents similarly. I can also run this locally later and try to fix it.

As for NAKIT, I recall they gave us the translated documents and we just put them there, so might be we don't need to update those. The attribute that's missing, as effect, has the documents unordered under the cs locale.

@morch23mj The linking works as expected when running the documentation website locally...