Skip to content

Improve How To section #833

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 16 commits into from
Mar 17, 2021
Merged

Improve How To section #833

merged 16 commits into from
Mar 17, 2021

Conversation

@dichotommy
Copy link
Contributor

@dichotommy dichotommy commented Mar 6, 2021

Closes #346
Closes #660

@dichotommy dichotommy requested review from bidoubiwa and fharper March 6, 2021 21:57
@dichotommy
Copy link
Contributor Author

dichotommy commented Mar 6, 2021 •
edited
Loading

For the new updating guide, I used RouteHighlighter elements out of a desire to make the guide more "general" and less curl-specific, but they make it look pretty messy. Ultimately I think we should replace these with new code samples pulling from all SDKs, since I imagine people will want to automate the update process.

On the other hand, it's worth asking whether it's worth the effort to do so, since I believe v0.20.0 is intended to be the last release before v1.0.0 which will make this whole guide obsolete. 😬 We could always remove the RouteHighlighter elements and just stick to examples using curl.

CaroFG
CaroFG reviewed Mar 8, 2021
View reviewed changes
bidoubiwa
bidoubiwa suggested changes Mar 8, 2021
View reviewed changes
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Incredible guide 🔥🔥🔥🔥 I love the separations in the create section. So clear

@CaroFG CaroFG mentioned this pull request Mar 10, 2021
Closed
@fharper
Copy link
Contributor

fharper commented Mar 10, 2021

You can request my review again once you address the previous comments.

@dichotommy dichotommy requested review from CaroFG and bidoubiwa March 11, 2021 17:20
bidoubiwa
bidoubiwa previously approved these changes Mar 11, 2021
View reviewed changes
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

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

🔥 LGTM

fharper
fharper suggested changes Mar 11, 2021
View reviewed changes
@dichotommy dichotommy mentioned this pull request Mar 16, 2021
Closed
dichotommy added 11 commits March 16, 2021 18:22
@dichotommy
Rework how-to sidebar
5c36fb4
@dichotommy
Edit Qovery guide
610bba3
@dichotommy
Reduce visual clutter, improve README.md
161cac7 
Set how to sidebarDepth to 0, organize sidebar categories, update README.md
@dichotommy
Edit updating.md
7cd6769
@dichotommy
Revise updating guide, update installation page.
70bb471
@dichotommy
Improve installation.md
9e3904c
@dichotommy
Fix link and style
92292b3
@dichotommy
Address feedback from bidoubiwa's review
00a94c8 
Improve guide on installing a specific MeiliSearch version; make explanation of dump directory clearer
@dichotommy
Add all curl examples
0ab4cc4 
Replace route descriptions with curl examples
@dichotommy
Make all code samples fit the window without scrolling
2669106
@dichotommy
Incorporate Fred's review
6ac6aea 
Also rename Getting Started guide (quick_start.md) as Quick Start
@fharper fharper self-requested a review March 17, 2021 19:04
fharper
fharper previously approved these changes Mar 17, 2021
View reviewed changes
Copy link
Contributor

@fharper fharper left a comment

Choose a reason for hiding this comment

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

Small changes & good to go :)

@dichotommy
Small changes
da5f780 
Change OSX to macOS, fix bug in Docker script, change wording
@dichotommy dichotommy requested a review from fharper March 17, 2021 19:28
@fharper
Copy link
Contributor

fharper commented Mar 17, 2021

Actually, for Windows, it's where.exe in CMD, but Get-Command in PowerShell (was too lazy to find the right conversation)

@dichotommy
Update PowerShell version of which command
6d2e994 
Unable to verify this, hopefully someone with a PC can test
fharper
fharper approved these changes Mar 17, 2021
View reviewed changes
Copy link
Contributor

@fharper fharper left a comment

Choose a reason for hiding this comment

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

MERGE THAT BASTARD!

@dichotommy dichotommy merged commit cba70a3 into master Mar 17, 2021
@dichotommy dichotommy deleted the how-to branch March 17, 2021 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@CaroFG CaroFG Awaiting requested review from CaroFG

2 more reviewers

@fharper fharper fharper approved these changes

@bidoubiwa bidoubiwa bidoubiwa left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add information about MeiliSearch behavior on Windows It's better to compile for performance

5 participants

@dichotommy @fharper @bidoubiwa @CaroFG