Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add option to use og:description as description #71

Merged
merged 1 commit into from
Oct 18, 2022

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Oct 18, 2022

For #65.

Adds a Boolean option for conf.py called enable_meta_description, which when true, will add the same description to <meta name="description" content="..."> as used for <meta property="og:description" content="...">.

We're looking into using this extension in the CPython docs (for example: official docs, devguide, PEPs), and improving the SEO by adding the meta description would be very helpful.

Re: python/docs-community#65

@Daltz333 Daltz333 merged commit 0dc991c into wpilibsuite:main Oct 18, 2022
@hugovk hugovk deleted the enable_meta_description branch October 18, 2022 19:13
TheTripleV added a commit that referenced this pull request Oct 21, 2022
PeterJohnson pushed a commit that referenced this pull request Oct 21, 2022
@TheTripleV
Copy link
Member

Sorry, this was merged prematurely. It's been reverted for now.

A few changes required:

  1. Config options should be preceded with ogp. I think ogp_enable_meta_description would be fine.
  2. I'm not a fan of modifying the config (config["ogp_custom_meta_tags"]). I understand that this is a workaround because tags is a dict. We deferred running make_tags on purpose to make it easier to detect conflicting tags.
  3. New config options should be added to the documentation.

I'll leave additional thoughts on the overall concept/de# #65.

@TheTripleV TheTripleV mentioned this pull request Oct 21, 2022
3 tasks
@hugovk
Copy link
Contributor Author

hugovk commented Oct 21, 2022

  1. Sounds good.
  2. Yes, that was replaced with another dict in Add support for meta description #72.
  3. Good idea.

But let's continue in #65.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants