Documentation punchlist

[reubenmiller]

Documentation updates

• Configuration Tools page - Docs/clarify configuration tools #2682

  The name of this file does not really match its contents, and it could be possibly moved to the index.md of the section rather than a sub-page, as it reads configuration->configuration which is redundant.

  Page: /operate/configuration/configuration-tools.md

• Missing Test AWS section - docs(aws): add aws connection test details #2675

  AWS sub section is missing on how to test the connection (only c8y and az are listed)

  Page: /operate/troubleshooting/testing-cloud-connection/

• Getting started

  • Remove explicit timestamps in both the events and alarms pages. Using a fixed timestamp is a bad idea as users will not be able to view the event in the UI due to the timestamp being in the past - docs(getting started): remove explicit timestamps from example commands #2650

  • Add note about the timestamp being able to be defined as a linux timestamp

• Remove workflow construction sign - docs: remove proposal banner from operation workflow reference #2648

  • The workflows are out of the proposal phase and should have the warnings removed.

• operate/c8y/software-management/

  • Remove sections about installing thin-edge.io via the Software Management feature and more focus on installing any software only with screenshots. - docs: refactor and extend software management docs #2667

• Legacy firmware management for child devices

  • Two pages for the same topic under the legacy child device topic - Merge how-to and reference docs for c8y-firmware-plugin #2665
    • tedge-docs/docs/legacy/child-device-firmware-management.md
    • tedge-docs/docs/legacy/firmware-management.md

• Getting started - Monitoring page

  • Use community package to automatically install collectd rather than going through complicated steps. - docs(collectd): simplify instructions by using a community plugin for installation and configuration #2674

Not Applicable

The following items have been removed as they are not mandatory and will only be actioned if required later.

• Remaining Thin Edge references

  • Renaming Thin Edge JSON to thin-edge.io JSON looks a bit strange for a title...not sure if there is a better option here, or we just live with it for now.

• Order of Operate Device section

  The order of the Operate Device section needs to be re-thought and maybe simplified.

[reubenmiller]

Closing the tracking ticket as all of the PRs have been created and are on their way to being merged.