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

Refactor go parsing code #2946

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

npentrel
Copy link
Collaborator

Description

Please include a summary of the change and what is does. Please also include relevant motivation and context.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label May 23, 2024
@viambot
Copy link
Member

viambot commented May 23, 2024

Overall readability score: 53.08 (🟢 +0)

File Readability
webhooks.md 53.21 (🟢 +0)
trigger-sync.md 66.29 (🟢 +0)
configure-a-fleet.md 70.03 (🟢 +0)
control.md 16.55 (🟢 +0)
machines.md 50.9 (🟢 +0)
provision.md 55.72 (🟢 +0)
_index.md 49.77 (🟢 +0)
air-quality-fleet.md 70.92 (🟢 +0)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
webhooks.md 53.21 48.94 11.26 15.3 11.95 7.21
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
trigger-sync.md 66.29 60.75 10.46 11.6 10.1 6.66
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
configure-a-fleet.md 70.03 61.36 9.01 11.6 10.56 6.1
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
control.md 16.55 0 14.8 22 19 8.09
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
machines.md 50.9 47.83 12.05 15.9 12.36 7
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
provision.md 55.72 40.08 10.97 14.5 12.02 6.46
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 49.77 36.52 12.18 16.7 12.36 6.34
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
air-quality-fleet.md 70.92 53.31 8.89 11.1 10.26 5.83
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.08 45.5 11.15 12.63 12.1 8.27
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@@ -3,7 +3,7 @@ title: "Configure a Webhook"
linkTitle: "Webhooks"
weight: 50
type: "docs"
description: "Configure a webhook to trigger actions when certain types of data are sent from your machine to the cloud, or when the internet connectivity of your machine changes."
description: "Configure a webhook to trigger actions when data is sent from your machine to the cloud, or when your machine's internet connectivity changes."
Copy link
Collaborator

Choose a reason for hiding this comment

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

is this intentional?

@@ -218,26 +218,24 @@ On your machine's **CONFIGURE** tab, switch to **JSON** mode and add a `selectiv
"type": "data_manager"
}
],
"agent_config": {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here: not sure if this was intentional or old version of file

@npentrel npentrel force-pushed the refactor-automation-code branch 4 times, most recently from b63bdca to 59fa9b5 Compare May 24, 2024 10:07
@npentrel npentrel changed the title Draft: refactoring Refactor go parsing code May 24, 2024
@npentrel npentrel marked this pull request as ready for review May 24, 2024 10:34
@viambot
Copy link
Member

viambot commented May 24, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2946

Copy link
Collaborator

@sguequierre sguequierre left a comment

Choose a reason for hiding this comment

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

LGTM

@npentrel npentrel requested a review from andf-viam May 24, 2024 15:54
@npentrel
Copy link
Collaborator Author

@andf-viam also requesting your review here before I merge

@andf-viam
Copy link
Contributor

@npentrel I was hoping to hold off on refactors until the remainder of the enhancement work. Example: I am updating this same code right now. Would you mind if you held off on this until I can do all SDK languages in same fashion? I appreciate you showing me how you'd do it: I can take that and do all -- but next week please.

@npentrel npentrel marked this pull request as draft May 24, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants