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

[META] The SEO Meta per page project #791

Open
Valastiri opened this issue Apr 12, 2023 · 0 comments
Open

[META] The SEO Meta per page project #791

Valastiri opened this issue Apr 12, 2023 · 0 comments

Comments

@Valastiri
Copy link
Member

Valastiri commented Apr 12, 2023

To facilitate better searches and improve our SEO across the board we should begin standardizing meta on each page (placed at the top of a page) with some basic information:

Meta

Meta example:

---
title: FlyByWire A32NX - Overview 
description: This section is dedicated to the FlyByWire A32NX aircraft and its features.
---

the title may not be required as the mkdocs-material theme will take the H1 element but it is useful and important for index.md pages.

We only have those two available to us on the non-insider version of material. Which should suffice in the meantime.

Tags

https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/

We have some tags already setup but it would be best to solidify the use case and come up with a plan. Essentially it would allow us to group pages and search items to bring more relevant information up the search index. (Put simply).

Ideally, not every page would have a tag but that could be up for debate.

Action plan

To simplify reviews and the amount of work required should probably tackle the pages in groups per PR and will update this tracking issue appropriately.

For tags should probably be done with the same groups below but in a separate PR i.e. don't add meta and tags into the same pull request as it might get confusing to test/review.

Reference the group in the PR title.

FBWA32NX

Group 1

Linked PR:

Group 2

Linked PR:

Pilot's Corner

Group 3

  • Beginner Guide (different meta per page)

Group 4

  • Advanced Guides (index.md)
  • Flight Phases
  • Protections (all pages)
  • Data management
  • Ice and rain protections
  • rejected takeoff

Group 5

  • Flight Planning (all pages)
  • Flight Guidance (all pages)
  • Note: there is a the vertical guidance here that contains multiple pages.
  • Protections

Other groups to follow.

@Valastiri Valastiri pinned this issue Apr 12, 2023
marcpicaud added a commit to marcpicaud/docs that referenced this issue Mar 9, 2024
For the pages listed in "Group 1" in this issue flybywiresim#791
marcpicaud added a commit to marcpicaud/docs that referenced this issue Mar 10, 2024
For the pages listed as "Group 2" in flybywiresim#791
github-actions bot pushed a commit that referenced this issue Mar 11, 2024
* docs: add <meta> tags

For the pages listed in "Group 1" in this issue #791

* docs: shorter <meta> tags
marcpicaud added a commit to marcpicaud/docs that referenced this issue Mar 17, 2024
For the pages listed as "Group 3" in flybywiresim#791
marcpicaud added a commit to marcpicaud/docs that referenced this issue Mar 17, 2024
For the pages listed as "Group 3" in flybywiresim#791
github-actions bot pushed a commit that referenced this issue Mar 20, 2024
* docs: add <meta> tags (group 2)

For the pages listed as "Group 2" in #791

* docs: correct flyPadOS 3 branding

* docs(fms): clearer meta description

* docs(flight-planning): clearer meta description
github-actions bot pushed a commit that referenced this issue Apr 4, 2024
For the pages listed as "Group 3" in #791
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

No branches or pull requests

1 participant