Update frontmatter with keywords #14475
Conversation
|
Your site preview for commit bcb8d18 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-14475-bcb8d186.s3-website.us-west-2.amazonaws.com. |
sean1588
force-pushed
the
sean/add-keywords-frontmatter
branch
from
d8f9e17 to
2efc465
Compare
|
Your site preview for commit d8f9e17 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-14475-d8f9e179.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 2efc465 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-14475-2efc4654.s3-website.us-west-2.amazonaws.com. |
sean1588
force-pushed
the
sean/add-keywords-frontmatter
branch
from
7ff9b33 to
5f08699
Compare
There was a problem hiding this comment.
Interesting! IT doesn't feel like we're quite there yet as the keywords its picking out seem too general in a lot of cases, but let's keep playing with it!
(It might be interesting to run it on the blog posts too; those pages have a lot of content that probably isn't making it into the index)
| - /docs/esc-cli/ | ||
| search: | ||
| keywords: | ||
| - esc_env_version |
There was a problem hiding this comment.
do the underscores work in the index? I would have expected "esc env version"
| - esc_env | ||
| - environments | ||
| - env | ||
| - environment | ||
| - esc |
There was a problem hiding this comment.
hmm this list ends up pretty redundant (I think algolia can handle plurals?)
And it's kind of missing the obvious "list environments" keyword.
| - /docs/esc/sdk/ | ||
| search: | ||
| keywords: | ||
| - pulumi |
There was a problem hiding this comment.
probably should black list "pulumi" from being used as a keyword
| - esc | ||
| - node | ||
| - javascript | ||
| - typescript |
There was a problem hiding this comment.
surprised we don't get "SDK" for this page or "language"
The javascript/typescript keywords also seem pretty weak since they are so general.
Generate keywords and add them to frontmatter.
This PR reads in the markdown files and uses the content to generate keywords. It then writes back the frontmatter to the file with keywords list under search.keywords.
1st commit - contains python script used to gen
2nd commit - config just to enable it to generate in the testing environment and push to testing algolia index
3rd commit - some pages for reference to sample some of the results this produces. The results have a bit of a diff due to inconsistent yaml formatting like indentation and spacing. I tried to retain the integrity of this as much as possible but because of inconsistency, looks like there may be no way around it