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 frontmatter #132

Merged
merged 2 commits into from
Sep 7, 2020
Merged

Add missing frontmatter #132

merged 2 commits into from
Sep 7, 2020

Conversation

36degrees
Copy link
Contributor

Context

Document missing and new frontmatter options.

Changes proposed in this pull request

  • Document existing 'description' frontmatter, used used by search engines (<meta name="description">) and when shared on social media (<meta property="og:description">)
  • Document new prevent_indexing frontmatter, which will be introduced in in Fixes and improvements to meta tags tech-docs-gem#192

Guidance to review

You can verify how the description frontmatter is used here.

The 'prevent_indexing` option could previously be set as a site-wide option but alphagov/tech-docs-gem#192 will make it possible to set it at the individual page level using the page frontmatter.

@m-green m-green self-requested a review September 4, 2020 11:02
Copy link
Contributor

@m-green m-green left a comment

Choose a reason for hiding this comment

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

Looks good, thank you! Couple of suggested tweaks, hope they look ok.

source/configure_project/frontmatter/index.html.md.erb Outdated Show resolved Hide resolved
source/configure_project/frontmatter/index.html.md.erb Outdated Show resolved Hide resolved
source/configure_project/frontmatter/index.html.md.erb Outdated Show resolved Hide resolved
source/configure_project/frontmatter/index.html.md.erb Outdated Show resolved Hide resolved
Depends on alphagov/tech-docs-gem#192 being merged and released.

Co-authored-by: Mark Green <mark.green@digital.cabinet-office.gov.uk>
@36degrees 36degrees force-pushed the add-missing-frontmatter branch from 4902d39 to c1307bd Compare September 4, 2020 13:32
Copy link
Contributor

@m-green m-green left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@36degrees 36degrees merged commit e9e7b74 into master Sep 7, 2020
@36degrees 36degrees deleted the add-missing-frontmatter branch September 7, 2020 15:01
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