Skip to content

Conversation

reubenmiller
Copy link
Contributor

Proposed changes

Add instructions for Cumulocity IoT users which are using the custom domain feature.

Add both instructions to a dedicated section (which is easier to link to), and add the error message in the "common errors" section.

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

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller temporarily deployed to Test Pull Request July 1, 2024 14:25 — with GitHub Actions Inactive
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:c8y Theme: Cumulocity related topics labels Jul 1, 2024
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

```

:::tip
If you have `curl` and `jq` installed, then you can check if you are using a custom domain by executing the following command. If the response includes a different domain than the url used in the curl command, then you are using a custom domain, and you should use the output to set the `c8y.mqtt` thin-edge.io setting instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

This tip suggests that thin-edge could do the same to infer c8y.mqtt from c8y.http.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Potentially, though we'd have to do some more testing to make sure it works in all cases (where as a doc statement is a lot more forgiving).

Copy link
Contributor

github-actions bot commented Jul 1, 2024

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
454 0 3 454 100 1h0m11.488580999s

@reubenmiller reubenmiller added this pull request to the merge queue Jul 1, 2024
Merged via the queue into thin-edge:main with commit c1f54bf Jul 1, 2024
@reubenmiller reubenmiller deleted the docs-custom-domains branch July 18, 2024 13:37
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 theme:c8y Theme: Cumulocity related topics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants