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

Test problem relrf shared file #383

Closed
wants to merge 1 commit into from

Conversation

knylander-grafana
Copy link
Contributor

@jdbaldry FYI -

Shared content doesn't seem to work on the shortcodes page. The relref example file is used in two files: write/shortcode and review/run-a-local-webserver. The included content appears on the webserver page but not on the shortcode page.

Here's what I tried for troubleshooting:

  • Removed the version="" from the include line - no change
  • Changed the front matter of the include file docs/sources/shared/hugo-error-example-bad-link.md to match make-help.md {{< docs/shared source="writers-toolkit" lookup="make-help.md" >}}. Tested via make docs, include file didn't show up.
  • Copied the make-help.md include from review/doc-validator/_index page (where the include appeared on the site preview) into the shortcode page (where none of the includes appeared on the rendered page)
  • Shared file for make-help.md was included whether or not the file name was index.md or _index.md.

Copy link
Contributor

Overall readability score: 60.59 (🟢 +0)

File Readability
index.md 63 (🟢 +0.25)
hugo-error-example-bad-link.md 2.49 (🟢 +0)
index.md 64.29 (🔴 -0.18)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 63 47.28 8.69 11.9 12.47 6.76
  🟢 +0.25 🟢 +0 🟢 +0.04 🟢 +0.1 🟢 +0 🟢 +0.01
hugo-error-example-bad-link.md 2.49 0 19 22 18.99 10.23
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
index.md 64.29 47.18 8.63 12 12.47 6.34
  🔴 -0.18 🟢 +0 🟢 +0.01 🔴 -0.1 🔴 -0.06 🟢 +0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.59 47.52 9.59 11.67 12.09 7.31
  🟢 +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

{{< docs/shared source="writers-toolkit" lookup="hugo-error-example-bad-link.md" version="" >}}
{{< docs/shared source="writers-toolkit" lookup="hugo-error-example-bad-link.md" >}}

{{< docs/shared source="writers-toolkit" lookup="make-help.md" >}}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was a test. We need to make sure this line is removed if this PR is merged.

@jdbaldry
Copy link
Member

Fixed by 172798e

@jdbaldry jdbaldry closed this Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants