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

Prepare documentation for release 11/2020 of MeiliSearch #564

Merged
merged 7 commits into from
Nov 4, 2020

Conversation

bidoubiwa
Copy link
Contributor

@bidoubiwa bidoubiwa commented Oct 20, 2020

Prepare documentation for release 11/2020

@curquiza
Copy link
Member

curquiza commented Oct 20, 2020

Is it worth removing the maintenance error code as it is not removed from the codebase? See https://github.com/meilisearch/MeiliSearch/blob/4398f2c0234cc6c25910572a8eea59db66c3bb47/meilisearch-http/src/error.rs

Should we open an issue to ask the core-team to remove it?
Or is it ok for everyone to have the errors documentation not really synchronized with the errors in the code base? @bidoubiwa @LegendreM

@ManyTheFish
Copy link
Member

ManyTheFish commented Oct 20, 2020

I agree with @curquiza the health route don't return maintenance anymore but the error code still exists in meilisearch. If we remove this error code from documentation, it's only because the error is explicitly removed from meilisearch.

Which is not the case.

@curquiza @bidoubiwa you can open an issue to discuss about the error removal. 👍

@bidoubiwa
Copy link
Contributor Author

I agree that we should stay in sync, I think the error code should be removed from MeiliSearch and once it is done it will be removed here.

bidoubiwa and others added 7 commits November 4, 2020 13:05
* health route redesign

- change `GET /health` to constantly return `204 No Content`
- remove ` PUT /health`

* Update references/health.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>
Remove maintenance errorCode until it is a possible `errorCode` again.
* add dumps to safeguard guide

Update safeguard with dumps

Change wording of Dumps guide and add specification for dump batches

* Change safeguards into snapshots and dumps

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: Many <legendre.maxime.isn@gmail.com>

* Apply suggestions from code review

Co-authored-by: Many <legendre.maxime.isn@gmail.com>

* Apply suggestions from code review

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Resolve style

* Snapshot and Dumps redesign (#552)

* redisign

* dead links

* capitalize titles

* fix PR

* update snapshot_and_dumps file

* revert

* update snapshot_and_dumps file

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* revert

* Update guides/advanced_guides/configuration.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Update guides/advanced_guides/configuration.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Update guides/advanced_guides/configuration.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Update guides/advanced_guides/snapshots_and_dumps.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* Update guides/advanced_guides/configuration.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

* remove env var on opt-in flag and on 'action' flags

* Update guides/advanced_guides/configuration.md

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

Co-authored-by: Many <legendre.maxime.isn@gmail.com>
Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>
* Change documents references

* Add lazy index to indexes main concept

* Remove duplicate lazy index information

* lazy index doc for references (#572)

* lazy index doc for references

* Update references/indexes.md

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

* Apply suggestions from code review

Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>

Co-authored-by: Quentin de Quelen <quentin@meilisearch.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com>
@bidoubiwa bidoubiwa merged commit e28160d into master Nov 4, 2020
@bidoubiwa bidoubiwa deleted the prepare-meilisearch-11-2020 branch November 4, 2020 13:17
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.

None yet

3 participants