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

Fix code samples (remove useless, and add missing) #1580

Merged
merged 2 commits into from
Sep 20, 2023
Merged

Conversation

curquiza
Copy link
Member

@curquiza curquiza commented Sep 18, 2023

I created scripts to manage code samples (internal only)

I found out the following code samples are still in this repo but not used by the documentation anymore:

meilisearch-js
- 'documents_guide_add_movie_1' not found in documentation
- 'getting_started_communicating_with_a_protected_instance' not found in documentation
- 'faceted_search_facets_1' not found in documentation
- 'faceted_search_2' not found in documentation

And the missing code samples

meilisearch-js
- 'getting_started_typo_tolerance' not found

I also changed some " into '

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@curquiza curquiza added skip-changelog The PR will not appear in the release changelogs maintenance Issue about maintenance (CI, tests, refacto...) labels Sep 18, 2023
@curquiza curquiza requested a review from bidoubiwa September 18, 2023 15:50
@codecov
Copy link

codecov bot commented Sep 18, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (cfd27e6) 97.25% compared to head (6f18e5e) 97.25%.
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1580   +/-   ##
=======================================
  Coverage   97.25%   97.25%           
=======================================
  Files          22       22           
  Lines         765      765           
  Branches      108      108           
=======================================
  Hits          744      744           
  Misses         20       20           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@mdubus mdubus left a comment

Choose a reason for hiding this comment

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

LGTM ✨🦕

bors merge

meili-bors bot added a commit that referenced this pull request Sep 20, 2023
1580: Fix code samples (remove useless, and add missing) r=mdubus a=curquiza

I created [scripts to manage code samples](https://github.com/meilisearch/integration-automations/pull/164) (internal only)

I found out the following code samples are still in this repo but not used by the documentation anymore:

```bash
meilisearch-js
- 'documents_guide_add_movie_1' not found in documentation
- 'getting_started_communicating_with_a_protected_instance' not found in documentation
- 'faceted_search_facets_1' not found in documentation
- 'faceted_search_2' not found in documentation
```

And the missing code samples
```
meilisearch-js
- 'getting_started_typo_tolerance' not found
```

I also changed some `"` into `'`

1582: Fix broken link in README.md r=mdubus a=curquiza

Fixes #1581 

Related to: meilisearch/documentation#2566

Co-authored-by: curquiza <clementine@meilisearch.com>
Co-authored-by: Clémentine U. - curqui <clementine@meilisearch.com>
@meili-bors
Copy link
Contributor

meili-bors bot commented Sep 20, 2023

This PR was included in a batch that successfully built, but then failed to merge into main. It will not be retried.

Additional information:

{"message":"Changes must be made through a pull request.","documentation_url":"https://docs.github.com/articles/about-protected-branches"}

@curquiza
Copy link
Member Author

bors merge

@meili-bors
Copy link
Contributor

meili-bors bot commented Sep 20, 2023

@curquiza curquiza merged commit b66fa3a into main Sep 20, 2023
@curquiza curquiza deleted the fix-code-samples branch September 20, 2023 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Issue about maintenance (CI, tests, refacto...) skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants