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: update Telemetry Formats section #7173

Merged
merged 2 commits into from Nov 2, 2023
Merged

docs: update Telemetry Formats section #7173

merged 2 commits into from Nov 2, 2023

Conversation

ozyx
Copy link
Member

@ozyx ozyx commented Oct 24, 2023

Closes #7172

Describe your changes:

Updates our docs on Formats/Formatters and documents the default formats that Open MCT API provides.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Command line build passes?
  • Has this been smoke tested?
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?
  • Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
  • Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

@ozyx ozyx added the type:docs updates to documentation label Oct 24, 2023
@deploysentinel
Copy link

deploysentinel bot commented Oct 24, 2023

Current Playwright Test Results Summary

✅ 14 Passing

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 11/02/2023 09:09:47pm UTC)

Run Details

Running Workflow e2e-couchdb on Github Actions

Commit: 8f142e5

Started: 11/02/2023 09:07:50pm UTC

View Detailed Build Results


Current Playwright Test Results Summary

✅ 152 Passing - ⚠️ 4 Flaky

Run may still be in progress, this comment will be updated as current testing workflow or job completes...

(Last updated on 11/02/2023 09:09:47pm UTC)

Run Details

Running Job e2e-stable on CircleCI

Commit: 8f142e5

Started: 11/02/2023 09:03:01pm UTC

⚠️ Flakes

📄   functional/plugins/notebook/restrictedNotebook.e2e.spec.js • 2 Flakes

Top 1 Common Error Messages

null

2 Test Cases Affected

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Restricted Notebook with a page locked and with an embed @addinit Allows embeds to be deleted if page unlocked @addinit
Retry 1Initial Attempt
5.22% (6) 6 / 115 runs
failed over last 7 days
39.13% (45) 45 / 115 runs
flaked over last 7 days
Restricted Notebook with a page locked and with an embed @addinit Disallows embeds to be deleted if page locked @addinit
Retry 1Initial Attempt
6.42% (7) 7 / 109 runs
failed over last 7 days
35.78% (39) 39 / 109 runs
flaked over last 7 days

📄   functional/plugins/imagery/exampleImagery.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Example Imagery Object Can use Mouse Wheel to zoom in and out of latest image
Retry 1Initial Attempt
0% (0) 0 / 115 runs
failed over last 7 days
6.09% (7) 7 / 115 runs
flaked over last 7 days

📄   functional/plugins/notebook/notebookSnapshots.e2e.spec.js • 1 Flake

Test Case Results

Test Case Last 7 days Failures Last 7 days Flakes
Snapshot image tests Can drop an image onto a notebook and create a new entry
Retry 1Initial Attempt
3.48% (4) 4 / 115 runs
failed over last 7 days
67.83% (78) 78 / 115 runs
flaked over last 7 days

View Detailed Build Results


@ozyx ozyx requested a review from jvigliotta October 24, 2023 22:05
@unlikelyzero unlikelyzero added this to the Target:3.2.0 milestone Oct 26, 2023
@unlikelyzero
Copy link
Collaborator

Looks great. I'm wondering if we should make sure that openmct-yamcs references this doc in some way

Copy link

codecov bot commented Nov 2, 2023

Codecov Report

Merging #7173 (8f142e5) into master (02f1013) will decrease coverage by 0.32%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #7173      +/-   ##
==========================================
- Coverage   55.98%   55.66%   -0.32%     
==========================================
  Files         652      652              
  Lines       26187    26187              
  Branches     2524     2524              
==========================================
- Hits        14660    14578      -82     
- Misses      10828    10912      +84     
+ Partials      699      697       -2     
Flag Coverage Δ *Carryforward flag
e2e-full 41.44% <ø> (ø) Carriedforward from 02f1013
e2e-stable 57.94% <ø> (-0.24%) ⬇️
unit 48.94% <ø> (-0.46%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

see 11 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 02f1013...8f142e5. Read the comment docs.

@ozyx ozyx added the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 2, 2023
@github-actions github-actions bot removed the pr:e2e:couchdb npm run test:e2e:couchdb label Nov 2, 2023
@ozyx ozyx merged commit 0d27938 into master Nov 2, 2023
12 of 13 checks passed
@ozyx ozyx deleted the update-format-docs branch November 2, 2023 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs updates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Open MCT provided formatters
2 participants