documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Content + menu changes due to Developer Hub

Open dichotommy opened this issue 2 years ago • 6 comments

Meilisearch's new Developer Hub is in development and will take some content from the docs for its MVP.

Pinging @mdubus who is developing the site, and @meilisearch/docs-team who are affected.

Affected documentation pages

Here are the pages that will be affected along with what will happen to their content:

What is Meilisearch section: deleted

  • comparison_to_alternatives.md -> Dev Hub
  • contact.md -> Dev Hub OR landing page
  • features.md -> Dev Hub OR deleted
    • Note that this page is currently out of date. Will need to be updated if moved to the Dev Hub.
  • language.md -> incorporated into FAQ
    • Add a sentence or two to overview.md about the languages Meilisearch supports, so that this information is still present on the docs and shows up on search
  • overview.md -> Getting Started
  • philosophy.md -> absorbed into learn/what_is_meilisearch/overview.md
  • sdks.md -> Getting Started
  • search_preview.md -> Getting Started
  • telemetry.md -> Advanced Topics

Cookbooks section: deleted

  • aws.md -> Dev Hub
  • azure.md -> Dev Hub
  • digitalocean_droplet.md -> Dev Hub
  • gcp.md -> Dev Hub
  • http2_ssl.md -> Dev Hub
  • koyeb.md -> Dev Hub
  • postman_collection.md -> Dev Hub
  • qovery.md -> Dev Hub
  • railway.md -> Dev Hub
  • running_production.md -> Dev Hub
  • search_bar_for_docs.md -> Dev Hub

FAQs page: moved to Dev Hub

The docs after these changes

For visualization purposes:

Main documentation menu

  • Learn
  • Reference
  • Integrations
  • More Meilisearch

Learn section

  • Getting Started
    • What is Meilisearch (previously What is Meilisearch -> Overview)
    • Quick start
    • Meilisearch 101
    • Official SDKs / libraries (previously inside What is Meilisearch)
    • Search preview (previously inside What is Meilisearch)
  • Core concepts
  • Configuration
  • Security and permissions
  • Advanced topics
    • Telemetry (previously inside What is Meilisearch)
  • Experimental
  • Contributing

dichotommy avatar Sep 14 '22 13:09 dichotommy

I'm not sure about the bigger picture here, but I'm against putting "Languages" inside an FAQ (no matter if in the docs or in the dev hub).

We're taking content that is specific and easy to find ("I want to know how Meilisearch works with languages, where should I go? Oh, there's a 'Languages' page, probably there") and putting it into what is essentially the most generic and least specific page we have in the whole website ("Ok, I have looked through the menu a few times, they don't have a good place for language info, guess I'll use the search bar").

IMHO, we should never move stuff that falls under a clear category into a good ol' bag of assorted questions. I like being edgy and strict, so I'd even go as far as saying we should never move content into the FAQ, but that's a different discussion.

guimachiavelli avatar Sep 14 '22 14:09 guimachiavelli

Actually, looking at the languages page right now, I think all the questions could be easily restructured into sections with proper titles and etc.

guimachiavelli avatar Sep 14 '22 14:09 guimachiavelli

That's a good point @guimachiavelli . We should consider our reasoning for moving content to the FAQ to avoid treating it as a "junk drawer".

About the Languages page—from my perspective, there are only two pieces of critical information on this page:

  1. Meilisearch should work for any language in theory, but only has optimized processes for one language group (whitespace) and three specific languages (Chinese, Japanese, Hebrew)
  2. The Meilisearch team will not develop support for additional languages ourselves—it needs to come from the community

I am sure that users will be curious to know all of this. On the other hand, if we present that information efficiently then it will make for a very short page. For this reason, it might be better to mention these two things in another section of an existing page, particularly if the Language page would throw off existing categories.

It's worth noting as well that the first version of the Developer Hub will not have a search bar. Because of this, it may make more sense to keep the FAQ in the documentation for the first iteration, since at least there it would be searchable.

dichotommy avatar Sep 14 '22 14:09 dichotommy

I think the Algolia guide will also be shifted to the Developer Hub if I am not mistaken cc @ferdi05

shivaylamba avatar Sep 14 '22 15:09 shivaylamba

Indeed @shivaylamba , that will be the case eventually. I don't know yet if this will come with the first version of the Developer Hub, we'll figure this out later

ferdi05 avatar Sep 15 '22 08:09 ferdi05

I largely agree with you, @dichotommy, though I'm not sure having a short page is a problem. Given how the question of what languages work with Meilisearch seems reasonable and very significant (I wouldn't be surprised if this is one of first questions a non-anglophone programmer asks when considering Meilisearch), I still think it deserves its own page.

Also, very good to know that we won't initially have a search bar. Good information architecture will be super important, as users won't have a fallback option to find content.

guimachiavelli avatar Sep 22 '22 15:09 guimachiavelli

@Strift, this is a bit of an old discussion and much of it might no longer be relevant, but perhaps it might help with the dev hub stuff you're working on?

guimachiavelli avatar Oct 04 '23 16:10 guimachiavelli

@guimachiavelli could we close it? I guess the devhub discussions and progressions will be be handled here, but I might be wrong

curquiza avatar Oct 19 '23 14:10 curquiza

Discussed with @guimachiavelli Indeed, this issue is about devhub and we can close it here since the management of devhub is not done in this repository

curquiza avatar Oct 31 '23 10:10 curquiza

Hi when is the devhub being launched? @curquiza

shivaylamba avatar Oct 31 '23 10:10 shivaylamba

@shivaylamba we would like to release something in the first part of next year

curquiza avatar Oct 31 '23 15:10 curquiza

Alright thank you

shivaylamba avatar Oct 31 '23 15:10 shivaylamba

Looking forward to it!

shivaylamba avatar Oct 31 '23 15:10 shivaylamba