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

Update registry upload with new cli behavior #2280

Merged
merged 3 commits into from
Nov 29, 2023
Merged

Conversation

zaporter-work
Copy link
Member

@zaporter-work zaporter-work commented Nov 29, 2023

Description

This page contained some references to the now-removed behavior regarding names & requirements for specifying an org-id.

Now all modules use a module_id field in their meta.json so the action does not need the org_id and the name field does not exist anymore

The action PR: https://github.com/viamrobotics/upload-module/pull/5/files

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Nov 29, 2023
@viambot
Copy link
Member

viambot commented Nov 29, 2023

Overall readability score: 57.25 (🟢 +0)

File Readability
_index.md 63.53 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 63.53 44.54 9.13 12.4 11.95 6.22
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 57.25 49.04 10.39 12.79 11.86 7.6
  🟢 +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

andf-viam added a commit to viamrobotics/upload-module that referenced this pull request Nov 29, 2023
To match viamrobotics/docs#2280, removing `org-id` from GH action yaml.
Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

LGTM, added a small formatting / link change.

Do we also need this change: viamrobotics/upload-module#6 ?

Thanks for this!!

docs/registry/upload/_index.md Outdated Show resolved Hide resolved
@viambot
Copy link
Member

viambot commented Nov 29, 2023

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

@zaporter-work zaporter-work merged commit f4e86c6 into main Nov 29, 2023
12 checks passed
@zaporter-work zaporter-work deleted the zaporter-work-patch-1 branch November 29, 2023 22:03
sguequierre pushed a commit to sguequierre/docs that referenced this pull request Dec 5, 2023
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