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

Add missing front matter for keywords and description #2

Closed
bravo-kernel opened this issue Dec 22, 2019 · 6 comments
Closed

Add missing front matter for keywords and description #2

bravo-kernel opened this issue Dec 22, 2019 · 6 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed markdown Markdown only

Comments

@bravo-kernel
Copy link
Collaborator

Currently, the website pages/markdown files are missing front matter variables description and keywords which will be used as html meta tags.

Both variables should be added so the markdown looks similar to:

---
id: quick-start
title: Quick Start
sidebar_label: Quick Start
description: Some appropriate page-specific description
keywords:
  - Pester
  - Powershell
  - etc.
  - etc.
---
@bravo-kernel bravo-kernel added good first issue Good for newcomers help wanted Extra attention is needed markdown Markdown only labels Dec 22, 2019
@bravo-kernel bravo-kernel changed the title Add missing meta tags for keywords and description Add missing front matter for keywords and description Dec 22, 2019
@fflaten
Copy link
Collaborator

fflaten commented Jun 6, 2022

Do you know if keywords will help DocSearch? Because they're not used by search engines anymore AFAIK, so if not we could ignore that.

Description meta-tags are created using the first lines of content (no headings) when not specified explicitly. In many cases those are fine. Should we focus on adding a quick 1-2 line intro per file when missing maybe? Thoughts?
image

@bravo-kernel
Copy link
Collaborator Author

Ah, I needed to figure out what I intended here but I remember again:

  • only relates to (all) static .mdx files in folder repo/docs
  • your suggestion for description sounds great: "first lines unless that doesn't work". E.g. for the Unit Testing within Modules example above I think we would need to make something up like Detailed instructions on the two Pester methods available to perform unit tests and mocks within Powershell Modules.
  • IMO nobody really knows if keywords are not used for SEO anymore but why take the risk plus we might exclude ourselves from other tools that use keywords if we choose do not add them

Hope this clarifies things 💃

@bravo-kernel
Copy link
Collaborator Author

Of course not needed for the auto-generated files in repo/docs/commands. I see I already auto-generate those fields.

https://raw.githubusercontent.com/pester/docs/master/docs/commands/Add-ShouldOperator.mdx

@bravo-kernel
Copy link
Collaborator Author

@fflaten can this one be closed now? The canonical did its job as well btw, good job!

@fflaten
Copy link
Collaborator

fflaten commented Jul 2, 2022

Yes, but it doesn't look like the descriptions have been indexed yet on Google.

@bravo-kernel
Copy link
Collaborator Author

Great, I will close. As far as Google is concerned, I am getting used to wait for weeks 🤦‍♀️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed markdown Markdown only
Projects
None yet
Development

No branches or pull requests

2 participants