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 "CRUD operations" and "Understanding FerretDB" sections #1232

Merged

Conversation

Fashander
Copy link
Member

@Fashander Fashander commented Oct 7, 2022

Description

Closes #1215.
Closes #1216.

Added documentation for all the basic CRUD commands, and explainer on FerretDB documents, collections, and data model

Readiness checklist

  • I added tests for new functionality or bugfixes.
  • I ran task all, and it passed.
  • I added/updated comments for both exported and unexported top-level declarations (functions, types, etc).
  • I checked comments rendering with task godocs.
  • I ensured that the title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Assignee, Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@Fashander Fashander added the documentation Something user-visible is badly or not documented label Oct 7, 2022
@Fashander Fashander requested review from a team and AlekSi October 7, 2022 06:14
@vercel
Copy link

vercel bot commented Oct 7, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
ferret-db ✅ Ready (Inspect) Visit Preview Oct 18, 2022 at 10:43AM (UTC)

@vercel vercel bot temporarily deployed to Preview October 7, 2022 06:16 Inactive
@codecov
Copy link

codecov bot commented Oct 7, 2022

Codecov Report

Merging #1232 (c4cb30c) into main (7095b18) will decrease coverage by 0.06%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1232      +/-   ##
==========================================
- Coverage   67.05%   66.98%   -0.07%     
==========================================
  Files         270      270              
  Lines       12717    12717              
==========================================
- Hits         8527     8519       -8     
- Misses       3284     3290       +6     
- Partials      906      908       +2     
Impacted Files Coverage Δ
internal/util/version/version.go 48.52% <0.00%> (-4.42%) ⬇️
internal/handlers/pg/pgdb/query.go 51.41% <0.00%> (-2.83%) ⬇️
internal/handlers/common/filter.go 86.58% <0.00%> (ø)
Flag Coverage Δ
integration 62.97% <ø> (-0.03%) ⬇️
mongodb 14.08% <ø> (-0.03%) ⬇️
pg 52.37% <ø> (-0.03%) ⬇️
tigris 34.23% <ø> (-0.03%) ⬇️
unit 24.98% <ø> (-0.07%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Member

@AlekSi AlekSi left a comment

Choose a reason for hiding this comment

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

(for maintainers only) I set Reviewers, Assignee, Labels, Project and project's Sprint fields.

That's not done

@Fashander Fashander self-assigned this Oct 7, 2022
@Fashander Fashander requested review from AlekSi, a team, w84thesun and noisersup and removed request for a team October 7, 2022 09:10
@vercel vercel bot temporarily deployed to Preview October 10, 2022 07:25 Inactive
@AlekSi AlekSi added this to the v0.6.0 Alpha milestone Oct 10, 2022
@vercel vercel bot temporarily deployed to Preview October 10, 2022 11:56 Inactive
@vercel vercel bot temporarily deployed to Preview October 10, 2022 18:19 Inactive
@AlekSi AlekSi changed the title Add crud operations and understanding ferretdb sections Add "CRUD operations" and "Understanding FerretDB" sections Oct 11, 2022
@vercel vercel bot temporarily deployed to Preview October 11, 2022 08:55 Inactive
@AlekSi AlekSi requested a review from a team October 11, 2022 08:59
noisersup
noisersup previously approved these changes Oct 13, 2022
@vercel vercel bot temporarily deployed to Preview October 13, 2022 12:36 Inactive
chilagrow
chilagrow previously approved these changes Oct 14, 2022
Copy link
Contributor

@chilagrow chilagrow left a comment

Choose a reason for hiding this comment

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

Spotted tiny format issues, check out my comments.

I'm pre-approving 👏

website/docs/understanding_ferretdb.md Outdated Show resolved Hide resolved
website/docs/understanding_ferretdb.md Outdated Show resolved Hide resolved
Co-authored-by: chilagrow <chi.fujii@ferretdb.io>
@vercel vercel bot temporarily deployed to Preview October 14, 2022 13:21 Inactive
Copy link
Contributor

@chilagrow chilagrow left a comment

Choose a reason for hiding this comment

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

Looking good! 🚀

@vercel vercel bot temporarily deployed to Preview October 17, 2022 05:27 Inactive
@vercel vercel bot temporarily deployed to Preview October 17, 2022 11:28 Inactive
Copy link
Member

@rumyantseva rumyantseva left a comment

Choose a reason for hiding this comment

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

LGTM

@vercel vercel bot temporarily deployed to Preview October 18, 2022 10:43 Inactive
@AlekSi AlekSi enabled auto-merge (squash) October 18, 2022 10:48
@AlekSi AlekSi merged commit 91005cc into FerretDB:main Oct 18, 2022
@Fashander Fashander deleted the add-understanding-ferretdb-documentation-1215 branch October 27, 2022 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something user-visible is badly or not documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for basic CRUD commands Documentation for Understanding FerretDB
6 participants