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 Vercel guide to cookbooks #2523

Merged
merged 16 commits into from
Aug 22, 2023
Merged

Add Vercel guide to cookbooks #2523

merged 16 commits into from
Aug 22, 2023

Conversation

CaroFG
Copy link
Contributor

@CaroFG CaroFG commented Aug 2, 2023

Pull Request

Not to be merged before the release of the integration

Related issue

Fixes #2513

What does this PR do?

  • Adds guide inside /learn/cookbooks dir
  • Adds images inside /assets/images/vercel
  • Adds guide to /config/sidebar-learn.json under Cookbooks
  • Updates .github/CODEOWNERS assigning @CaroFG as the owner of the document

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@guimachiavelli guimachiavelli added this to the August 2023 milestone Aug 2, 2023
Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

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

I have made a few comments throughout the guide—mostly minor adjustments to bring the text more in line with the rest of the docs (both in tone/style and formatting).

I have one extra recommendation: break down the content after "## Create a Vercel project […]" with extra headings. This will help users navigate the text more easily and give them a way of quickly assess the required steps.

learn/cookbooks/vercel.mdx Show resolved Hide resolved
learn/cookbooks/vercel.mdx Show resolved Hide resolved
learn/cookbooks/vercel.mdx Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@Strift Strift left a comment

Choose a reason for hiding this comment

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

Looks good to me, but I wish we'd say "meilisearch integration" instead of "Meilisearch Cloud integration". It sounds more impactful to me.

Not a big deal though :)

config/sidebar-learn.json Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
@CaroFG CaroFG requested a review from Strift August 9, 2023 13:01
Copy link
Contributor

@Strift Strift left a comment

Choose a reason for hiding this comment

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

Overall good except for 1 paragraph to cut down and UTM params to add on links.

I would go for:

  • utm_campaign=oss
  • utm_source=docs
  • utm_medium=vercel-integration

(FYI @curquiza)

Don't forget to add the line in the UTM tracking page in Notion.

learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
learn/cookbooks/vercel.mdx Outdated Show resolved Hide resolved
@CaroFG CaroFG requested a review from Strift August 9, 2023 15:00
Strift
Strift previously approved these changes Aug 9, 2023
Copy link
Contributor

@Strift Strift left a comment

Choose a reason for hiding this comment

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

LGTM, except for the extra space :)

@github-actions
Copy link

github-actions bot commented Aug 10, 2023

All broken links are now fixed, thank you!

@curquiza
Copy link
Member

curquiza commented Aug 10, 2023

(Maybe a rebase would fix the broken link. I say maybe because it's a tool we just introduced)

@CaroFG
Copy link
Contributor Author

CaroFG commented Aug 16, 2023

(Maybe a rebase would fix the broken link. I say maybe because it's a tool we just introduced)

Current branch add-vercel-guide is up to date.

@guimachiavelli guimachiavelli merged commit 43f4a47 into main Aug 22, 2023
2 checks passed
@guimachiavelli guimachiavelli deleted the add-vercel-guide branch August 22, 2023 15:18
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

Successfully merging this pull request may close these issues.

Create Vercel guide
5 participants