documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Migrating guides from the blog

Open Strift opened this issue 1 year ago • 7 comments

Creating this mega issue to track this project.

Context & Objectives

This Q1 2024, DevRel and Docs aim to migrate 'how to' content from the Meilisearch blog to the documentation.

Goals:

  • Improve discoverability of the content (docs has more traffic + better search)
  • Improve SEO of the meilisearch.com domain (blog is on a subdomain)

📆 Deadline: 10 pieces migrated/repurposed by the end of February 2024

Scope

We want to prioritize the migration of articles that can have the most impact. The criteria for prioritizing articles include:

  • Monthly traffic on the piece
  • Matching "Searches without results" analytics
  • Strategic alignment with go-to-market activities (i.e. frameworks, etc.)
  • Up-to-dateness of the content
  • Ease of migration

On top of this, we always consider existing limitations in the docs site in the prioritization. Notably, the parallel effort from @guimachiavelli in the reorganization of the content and the continuous iterations on the docs site will be kept in mind to provide the best experience for users in terms of content and in terms of discovery.

Content pieces

Will link the issues instead as they are created.

Based on traffic this past year, the most important pieces to migrate or repurpose are:

[!note] List items are checked after creating one or multiple issues to cover the full scope of the content to migrate/repurpose.

For an idea of other content pieces we could be migrating next, please refer to the Blog posts migration table (private link).

Tasks

  • #2697
  • #2703
  • #2712
  • #2713
  • #2719
  • #2731

Strift avatar Jan 25 '24 10:01 Strift

Hello here

I write here because I did not find a place to make a global comment on Blog posts migration table

Multiples points:

  • They are a lot of guides to migrate (not the list in this issue but the one in the table): 30 if I'm correct! Are all the guides useful to be in the docs? Some questions you can ask yourself
    • Do we have traffic on these guides?
    • What is the value of this guide regarding the main user paint points and needs? -> You should get the help of the product team on this 👍
  • are you ready @meilisearch/devrel-team to keep up to date 30 guides in the documentation? Since it's in the docs, it cannot afford to be outdated.
  • Also, are they already up to date? I see the Finding rubygems one shows a Meilisearch setting named rankingOrder I don't see in the repository at all, so I supposed it's outdated. If the guide is too outdated maybe we could take into consideration it's not useful (otherwise we would have gotten feedback), but most of all, it will take more time to migrate since we need to update it.

curquiza avatar Jan 25 '24 18:01 curquiza

Hi, after discussing the points above in a meeting with curqui and Thomas, we are now aligned on how to proceed. 🎉

The goal is to add 10 pieces to the documentation this February. The topics to prioritize are based on the 10 most-visited pieces that are listed in the issue description.


@guimachiavelli @CaroFG My goal for this week is to finish these pieces:

  • #2703
  • #2712
  • #2713

Strift avatar Feb 12 '24 15:02 Strift

Hey @curquiza @tpayet @qdequele @gmourier,

The deadline of the end of February is approaching. We have 2/10 pieces created. We will likely not meet the deadline. Most posts cannot be copy-pasted to the docs and require some rewriting (and reviewing), which takes more time than estimated.


Last week, I worked on:

  • #2714 (merged)
  • #2715 (in review)

This week, the priorities are:

  1. Merging #2715
  2. Submitting a PR for #2719
  3. Adding the suggested sections and submitting for review #2704

Strift avatar Feb 20 '24 16:02 Strift

Thank you @Strift 2 questions

  • How bad is it for your work to delay this deadline? (If I'm correct, there is no impact)
  • What is the new deadline you suggest?

curquiza avatar Feb 22 '24 13:02 curquiza

Hi,

Indeed, I don't think pushing back the deadline will have any consequences.

I suggest moving the deadline to the end of Q1, March 31st.


Last week, I worked on

  • Merging #2715
  • Opening #2720
  • Updating #2704

This week, there are no objectives on my side because the priority is on hybrid search.

Strift avatar Feb 26 '24 10:02 Strift

I'll be working on migrating Strapi v4 guide this week, issue #2731

CaroFG avatar Feb 26 '24 12:02 CaroFG

I migrated the LangChain semantic search tutorial #2777

CaroFG avatar Apr 08 '24 12:04 CaroFG

It seems the majority of this transition has been successful. There might still be some lower impact articles we didn't migrate, but since it's been a year it seems reasonable to assume we can consider this issue closed.

guimachiavelli avatar Mar 18 '25 15:03 guimachiavelli