Skip to content

docs: update links to Cumulocity documentation pages#3334

Merged
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-update-doc-links
Jan 17, 2025
Merged

docs: update links to Cumulocity documentation pages#3334
reubenmiller merged 2 commits intothin-edge:mainfrom
reubenmiller:docs-update-doc-links

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Update all references to Cumulocity's update documentation under https://cumulocity.com/docs/

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@reubenmiller reubenmiller requested review from a team and didier-wenzek as code owners January 16, 2025 17:04
@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Jan 16, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 16, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
553 0 2 553 100 1h29m42.900677s

* Trigger software update operations on the devices, to install specific packages from the repository.

Find more information about [managing the device software](https://cumulocity.com/guides/users-guide/device-management/#managing-device-software)
Find more information about [managing the device software](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-software)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticing that this not a simple s|guides/users-guide|docs|g update, do we have a tool to check broken links?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately no. The algolia crawler will detect this after the fact (as a worst case scenario), however I think someone needs to verify that the contents of the new links also makes sense (as some were not so obvious from the link names).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though it is good you commented here as it made me have a look around for tooling to validate external links. I did a test run of https://github.com/becheran/mlc, and whilst not perfect it did find a broken c8y doc link!

I'll evaluate adding a broken link checker into the CI pipeline (but there are still a few things to consider before doing so).

Copy link
Copy Markdown
Member

@rina23q rina23q left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for all corrections. I clicked all old and new links to verify the contents manually as it's not simple URL replacement from guides to docs... All look good.

@reubenmiller reubenmiller added this pull request to the merge queue Jan 17, 2025
Merged via the queue into thin-edge:main with commit 601b2c5 Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants