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 description prop to books, careers, integrations and workshops pages SEO #4898

Merged
merged 2 commits into from
Oct 19, 2023

Conversation

Mohith234
Copy link
Member

Description

Follow up PR for #4836 ( Comment )

Notes for Reviewers

  • I have checked all the templates for a field to add as a description to the SEO component
  • Found some fields suitable in the books, careers, integrations, and workshops pages.
  • The news pages have a field subtitle as a suitable field for description but when I look into the .mdx files there are majority of empty strings as subtitles so they were not included here.
  • Let me know If I need to add description to any other pages

Signed commits

  • Yes, I signed my commits.

@github-actions github-actions bot added area/learn Related to /learn section area/careers labels Sep 11, 2023
@l5io
Copy link
Contributor

l5io commented Sep 11, 2023

🚀 Preview for commit eb5d40d at: https://64ff6ff600d9d548e58e1352--layer5.netlify.app

Copy link
Contributor

@randychilau randychilau left a comment

Choose a reason for hiding this comment

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

Hi @Mohith234,

Nice job expanding your previous work into this PR. The changes look good and will help the SEO for current and future MDX pages using these templates.

LGTM!

Cheers,
Randy

@randychilau
Copy link
Contributor

Hi @Mohith234,

If you wanted expand your previous work even further in another PR, here are some possible tasks:

As you mentioned in your notes regarding the news pages, there was a field subtitle not being used.

  • to improve SEO for these pages, update the news mdx files with a proper frontmatter field and content to be shown in the head section. Options may include adding content for the subtitle field or adding a description field and using the first two sentences of the post as content.
  • find the instructions for creating MDX files in each collection (e.g. news) and review/update them to make sure it indicates which fields should be required before publishing and why.

Other mdx page collections that could benefit from better SEO:

  • there are MDX files in folders src/collections/members and content-learn that are using templates that could also be improved. (note: if the content for a potential field may seem too long (e.g. bio), you can use javascript techniques to only include a portion of that content in the field).

Cheers,
Randy

@Mohith234
Copy link
Member Author

Thanks @randychilau, Will be looking into it and extending to make a PR of that 🙌

@l5io
Copy link
Contributor

l5io commented Sep 15, 2023

🚀 Preview for commit d9023f0 at: https://65044eb17d7cc51b242a1af2--layer5.netlify.app

@Ghat0tkach
Copy link
Member

hey @Mohith234
Let's discuss it on the websites call.
I have already added your agenda as part of today's meeting minutes

https://docs.google.com/document/d/1XczAHXVe2FIWPqiF57ospJ43zw5cZQ7ui8mn39v5EvA/edit#heading=h.lohhtewfwima

@leecalcote
Copy link
Member

leecalcote commented Oct 19, 2023

If @randychilau approves, then I approve, too. 👏

@leecalcote leecalcote merged commit f52faa4 into layer5io:master Oct 19, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/careers area/learn Related to /learn section
Development

Successfully merging this pull request may close these issues.

5 participants