DTS documentation improvements

[pietrushnic]

Dasharo version

DTS v1.1.1

Affected component(s) or functionality

• Documentation

Brief summary

I don't think it make sense to create issue per every minor problem I see, because of that I decided to create one issue and if it would be needed we can create dedicated tickets.

• readme has no word about the fact build is cached and that artifacts will be downloaded from our mirror, but there is suggestion that build will take time
• there are simple formatting mistakes in readme: https://github.com/Dasharo/meta-dts#build-image-with-uefi-secure-boot-support
• shouldn't we link to releases?
• We have to clearly distinguish what belongs to meta-dts readme and what belongs to dasharo docs DTS section otherwise it would be hard to keep track of changes in both places, now we tracking supported platforms in both places, meta-dts readme has no information about version in which MSI PRO Z690-A DDR4 is supported
• documentation request: how to perform DTS release? I would like to know how to perform such release from start to end, knowing that procedure would be easier to offload it and check for potential issues during the process.

[TomaszAIR]

Connected issue #337, both should be handled before next release

[EduKav1813]

Latest state of things, checklist:

• "readme has no word about the fact build is cached and that artifacts will be downloaded from our mirror, but there is suggestion that build will take time"

  Dasharo documentation contains information about cache:
  "Thanks to publishing the build cache on cache.dasharo.com the time needed to finish the process should be significantly decreased." (source: docs/dasharo-tools-suite/documentation.md)

• "there are simple formatting mistakes in readme: https://github.com/Dasharo/meta-dts#build-image-with-uefi-secure-boot-support"

  I ran the pre-commit check for the latest version of meta-dts (a546c0d40031147e2b81c810b602efcd3d369657) and all check for all files pass.

• "shouldn't we link to releases?" - There is now a link to the latest release on the documentation: https://docs.dasharo.com/dasharo-tools-suite/releases/

• "We have to clearly distinguish what belongs to meta-dts readme and what belongs to dasharo docs DTS section otherwise it would be hard to keep track of changes in both places, now we tracking supported platforms in both places, meta-dts readme has no information about version in which MSI PRO Z690-A DDR4 is supported"

  In the latest version, only dasharo docs contains information about supported plarforms. meta-dts README.md has no mention of supported hardware.

• "documentation request: how to perform DTS release? I would like to know how to perform such release from start to end, knowing that procedure would be easier to offload it and check for potential issues during the process."

  meta-dts now contains the "Release process" section. (source: meta-dts/README.md)

[artur-rs]

@EduKav1813 thank you, we will include here changes in the documentation, to split the document into logical sections in the different files. Right now, this document needs to be shorter. All requirements are listed in the internal task.

[EduKav1813]

@artur-rs The split was successfully performed in Dasharo/docs#959. With it I am closing the issue.