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

Update Writing Guide #3424

Merged
merged 4 commits into from
Sep 25, 2023
Merged

Update Writing Guide #3424

merged 4 commits into from
Sep 25, 2023

Conversation

Fashander
Copy link
Member

Description

Readiness checklist

  • I added/updated unit tests (and they pass).
  • I added/updated integration/compatibility tests (and they pass).
  • I added/updated comments and checked rendering.
  • I made spot refactorings.
  • I updated user documentation.
  • I ran task all, and it passed.
  • I ensured that PR title is good enough for the changelog.
  • (for maintainers only) I set Reviewers (@FerretDB/core), Milestone (Next), Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

@Fashander Fashander added documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets labels Sep 25, 2023
@Fashander Fashander added this to the Next milestone Sep 25, 2023
@Fashander Fashander self-assigned this Sep 25, 2023
@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

Merging #3424 (4cc42d8) into main (b8f85e6) will increase coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3424      +/-   ##
==========================================
+ Coverage   74.26%   74.34%   +0.08%     
==========================================
  Files         415      415              
  Lines       25859    25859              
==========================================
+ Hits        19203    19226      +23     
+ Misses       5508     5490      -18     
+ Partials     1148     1143       -5     
Flag Coverage Δ
filter-true 69.80% <ø> (+0.10%) ⬆️
hana-1 ?
hana-2 ?
hana-3 ?
integration 69.80% <ø> (+0.10%) ⬆️
mongodb-1 4.67% <ø> (ø)
pg-1 42.97% <ø> (+0.02%) ⬆️
pg-2 42.72% <ø> (ø)
pg-3 43.17% <ø> (-0.11%) ⬇️
postgresql-1 ?
postgresql-2 ?
postgresql-3 ?
sort-false 69.80% <ø> (+0.10%) ⬆️
sqlite-1 41.97% <ø> (+0.09%) ⬆️
sqlite-2 41.38% <ø> (ø)
sqlite-3 42.21% <ø> (-0.07%) ⬇️
unit 24.58% <ø> (ø)

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

@@ -2,7 +2,7 @@
slug: url-slug-of-post # the URL slug of the blog post with dashes instead of spaces
title: This is the title of the FerretDB Blog post
author: Firstname Lastname
author_url: # link to website or GitHub account
author_url: # to website or GitHub account
Copy link
Member

Choose a reason for hiding this comment

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

That's seems to be an accidental change


For partner blog posts that involve testing FerretDB with another application, store related images in the same folder (even for multiple blog posts on the same product), as `/img/blog/partner-name/image.png`.

For other non-partner blog posts, store related blog post images in a folder using the published date as the folder name, for example, `/img/blog/2022-12-29/image.png`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For other non-partner blog posts, store related blog post images in a folder using the published date as the folder name, for example, `/img/blog/2022-12-29/image.png`.
For other blog posts, store related blog post images in a folder using the published date as the folder name, for example, `/img/blog/2022-12-29/image.png`.

"other non-partner" implies there are three categories, not two

@AlekSi
Copy link
Member

AlekSi commented Sep 25, 2023

Also, "Conform PR" fails

@AlekSi AlekSi disabled auto-merge September 25, 2023 15:27
@AlekSi AlekSi merged commit 15cd43f into FerretDB:main Sep 25, 2023
21 of 27 checks passed
@Fashander Fashander deleted the improve-guide branch December 4, 2023 08: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 trust PRs that can access Actions secrets
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants