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-2552: Add images user journey #2991

Merged
merged 15 commits into from
Jun 21, 2024
Merged

Conversation

JessamyT
Copy link
Collaborator

@JessamyT JessamyT commented Jun 6, 2024

Notes:

  • The diagram at the top isn't finalized; I realize it needs something at the end
  • The little (i) icons currently link to pretty hand-holdy content. I'd like to link to more reference-focused content on these, and perhaps add slightly more detail to this user journey as necessary when those become more referency
    • These icons would be made prettier with CSS :)
  • I'm not thrilled with the CSS of these table step things; would like to mess with more

Links: https://docs-test.viam.dev/2991/use-cases/image-data/
https://docs-test.viam.dev/2991/use-cases/deploy-ml/

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

viambot commented Jun 6, 2024

Overall readability score: 53.03 (🟢 +0.01)

File Readability
deploy-ml.md 64.93 (🟢 +14.98)
image-data.md 47.79 (🔴 -8.42)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
deploy-ml.md 64.93 59.03 10.35 13.1 9.11 6.81
  🟢 +14.98 🟢 +24.37 🟢 +0.04 🟢 +2.7 🟢 +3.89 🟢 +0.46
image-data.md 47.79 38.15 12.37 16.9 11.78 7.1
  🔴 -8.42 🔴 -10.39 🔴 -1.12 🔴 -1.7 🔴 -1.21 🔴 -0.19

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.03 45.61 11.11 12.68 12.16 8.27
  🟢 +0.01 🟢 +0.02 🟢 +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

@JessamyT JessamyT requested review from npentrel and removed request for npentrel June 6, 2024 02:28
docs/use-cases/image-ml.md Outdated Show resolved Hide resolved
docs/use-cases/image-ml.md Outdated Show resolved Hide resolved
@npentrel
Copy link
Collaborator

npentrel commented Jun 7, 2024

Based on Eliot's feedback yesterday, let's split this into multiple one that covers image capture and filtering and one that covers image capture, datasets labeling and ml. And let's exclude alerts today.

@JessamyT
Copy link
Collaborator Author

JessamyT commented Jun 7, 2024

Does that mean we duplicate the image capture content onto both? Maybe with an includes?

@npentrel
Copy link
Collaborator

@JessamyT you can now rebase


{{< table >}}
{{< tablestep >}}
{{<imgproc src="/icons/components/camera.svg" class="fill alignleft" style="max-width: 150px" declaredimensions=true alt="configure a camera component">}}
**1. Configure a camera**
**1. Configure a camera [_(i)_](/components/camera/)**

First, [create a machine](/cloud/machines/#add-a-new-machine) if you haven't yet.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you add the creating a machine as a prerequisite instead please as with the sensor journeys: https://github.com/viamrobotics/docs/pull/2986/files#commit-suggestions.


Start by collecting images from your cameras with the [data management service](/services/data/).
You can [view the data](/services/data/view/) on the **Data tab**.
{{% alert title="Tip" color="tip" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please move this under the steps for creating and labeling data. You might need to adjust the text a little but I think since it's more of an aside anyway it can go at the bottom of this segment

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Even though they'd need to do this during this step, before collecting the data?

Copy link
Collaborator

Choose a reason for hiding this comment

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

If they end up getting to the end of this and then having a few images that don't have the label I think that's ok. So yes

@JessamyT JessamyT requested a review from npentrel June 17, 2024 18:23
@JessamyT JessamyT changed the title Draft images user journey Add images user journey Jun 17, 2024
Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

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

A few small things, but also this isn't merge ready. Do you want to wait until my PR merges and then change the little info icons? You may also be able to copy the layout changes into your PR so you're not blocked

docs/use-cases/image-data.md Outdated Show resolved Hide resolved
docs/use-cases/image-data.md Show resolved Hide resolved
docs/use-cases/image-data.md Outdated Show resolved Hide resolved

Start by collecting images from your cameras with the [data management service](/services/data/).
You can [view the data](/services/data/view/) on the **Data tab**.
{{% alert title="Tip" color="tip" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

If they end up getting to the end of this and then having a few images that don't have the label I think that's ok. So yes

docs/use-cases/deploy-ml.md Outdated Show resolved Hide resolved
docs/use-cases/deploy-ml.md Outdated Show resolved Hide resolved
docs/use-cases/deploy-ml.md Outdated Show resolved Hide resolved
@npentrel npentrel force-pushed the howtoimage branch 2 times, most recently from 3f3472d to 1f36062 Compare June 21, 2024 12:11
@viambot
Copy link
Member

viambot commented Jun 21, 2024

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

@npentrel npentrel merged commit 00b6fce into viamrobotics:main Jun 21, 2024
9 checks passed
@npentrel
Copy link
Collaborator

Merging for now so we can test more easily

@JessamyT JessamyT deleted the howtoimage branch June 21, 2024 17:33
@JessamyT JessamyT changed the title Add images user journey DOCS-2522: Add images user journey Jun 21, 2024
@JessamyT JessamyT changed the title DOCS-2522: Add images user journey DOCS-2552: Add images user journey Jun 21, 2024
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.

3 participants