Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(getting started): remove explicit timestamps from example commands #2650

Conversation

reubenmiller
Copy link
Contributor

Proposed changes

remove explicit timestamps in example commands in the Getting Started section.

Removing the timestamps improves the user experience as it ensures the alarms/events are created at the time of execution and not in the past (which results in the data not being displayed in the c8y UI as it is too far in the past)

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

#2641

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

Remove the timestamps improves the user experience as it ensures the alarms/events are created at the time of execution and not in the past (which results in the data not being displayed in the c8y UI as it is too far in the past)

Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Feb 1, 2024
@reubenmiller reubenmiller mentioned this pull request Feb 1, 2024
17 tasks
Co-authored-by: Didier Wenzek <didier.wenzek@free.fr>
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

Copy link
Contributor

github-actions bot commented Feb 1, 2024

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
386 0 3 386 100 51m13.556s

@reubenmiller reubenmiller added this pull request to the merge queue Feb 1, 2024
Merged via the queue into thin-edge:main with commit dc6c591 Feb 1, 2024
18 checks passed
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.

None yet

2 participants