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.

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

Improve documentation for Docker #2396

Merged
merged 24 commits into from
Apr 14, 2023
Merged

Improve documentation for Docker #2396

merged 24 commits into from
Apr 14, 2023

Conversation

AlekSi
Copy link
Member

@AlekSi AlekSi commented Apr 11, 2023 •
edited
Loading

Description

Make it as simple and accessible as I can.

Also, do several tweaks here and there.

Closes FerretDB/engineering#27.

Readiness checklist

  • I added/updated unit tests.
  • I added/updated integration/compatibility tests.
  • 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), Assignee, Labels, Project and project's Sprint fields.
  • I marked all done items in this checklist.

AlekSi added 2 commits April 4, 2023 16:56
@AlekSi
Fix URL in the bug template
2acded7
@AlekSi
Merge branch 'main' into docker-docs
b6ff733 
# Conflicts:
#	.github/ISSUE_TEMPLATE/bug.yml
@AlekSi AlekSi added documentation Something user-visible is badly or not documented no ci labels Apr 11, 2023
@AlekSi AlekSi added this to the v1.1.0 milestone Apr 11, 2023
@AlekSi AlekSi self-assigned this Apr 11, 2023
@AlekSi AlekSi removed the no ci label Apr 13, 2023
@codecov
Copy link

codecov bot commented Apr 13, 2023 •
edited
Loading

Codecov Report

Merging #2396 (85e30ff) into main (12342c7) will decrease coverage by 37.58%.
The diff coverage is 75.00%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2396       +/-   ##
===========================================
- Coverage   64.33%   26.75%   -37.58%     
===========================================
  Files         392      392               
  Lines       19251    19251               
===========================================
- Hits        12385     5151     -7234     
- Misses       5963    13546     +7583     
+ Partials      903      554      -349
Impacted Files Coverage Δ
internal/handlers/common/aggregations/stage.go 0.00% <ø> (-20.00%) ⬇️
internal/handlers/common/msg_debugerror.go 0.00% <0.00%> (ø)
internal/handlers/hana/hana.go 0.00% <ø> (ø)
internal/handlers/pg/pg.go 20.89% <ø> (-58.21%) ⬇️
internal/handlers/tigris/tigris.go 0.00% <ø> (ø)
build/version/version.go 67.64% <100.00%> (ø)

... and 123 files with indirect coverage changes

Flag Coverage Δ
integration 4.72% <75.00%> (-52.60%) ⬇️
mongodb 4.72% <75.00%> (ø)
pg ?
unit 25.40% <75.00%> (-0.17%) ⬇️

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

@AlekSi AlekSi added the no ci label Apr 13, 2023
@AlekSi AlekSi added trust PRs that can access Actions secrets and removed no ci labels Apr 13, 2023
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 13, 2023 17:26 — with GitHub Actions Inactive
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 13, 2023 17:47 — with GitHub Actions Inactive
AlekSi
AlekSi commented Apr 13, 2023
View reviewed changes
build/version/generate.go Show resolved Hide resolved
build/version/version.go Show resolved Hide resolved
website/docs/configuration/logging.md Show resolved Hide resolved
website/docs/configuration/logging.md Show resolved Hide resolved
website/docs/quickstart-guide/docker.md Show resolved Hide resolved
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 13, 2023 17:56 — with GitHub Actions Inactive
@AlekSi AlekSi marked this pull request as ready for review April 13, 2023 17:56
@AlekSi AlekSi requested a review from a team April 13, 2023 17:56
@AlekSi AlekSi requested a review from a team as a code owner April 13, 2023 17:56
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 04:41 — with GitHub Actions Inactive
@AlekSi @rumyantseva
Update website/docs/quickstart-guide/docker.md
6816eb8 
Co-authored-by: Elena Grahovac <elena@grahovac.me>
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 05:19 — with GitHub Actions Inactive
@AlekSi AlekSi requested a review from rumyantseva April 14, 2023 05:20
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 05:24 — with GitHub Actions Inactive
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 05:59 — with GitHub Actions Inactive
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 06:15 — with GitHub Actions Inactive
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 08:29 — with GitHub Actions Inactive
KrishnaSindhur
KrishnaSindhur previously approved these changes Apr 14, 2023
View reviewed changes
@AlekSi AlekSi temporarily deployed to cloudflare-dev April 14, 2023 11:45 — with GitHub Actions Inactive
@AlekSi AlekSi requested a review from noisersup April 14, 2023 12:07
@AlekSi AlekSi disabled auto-merge April 14, 2023 12:22
@AlekSi AlekSi merged commit a7073d7 into FerretDB:main Apr 14, 2023
@AlekSi AlekSi deleted the docker-docs branch April 14, 2023 12:22
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 17, 2023
@AlekSi @fenogentov
Improve documentation for Docker (FerretDB#2396)
2fd13be 
Closes FerretDB/engineering#27.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AlekSi @fenogentov
Improve documentation for Docker (FerretDB#2396)
c73bcdb 
Closes FerretDB/engineering#27.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AlekSi @fenogentov
Improve documentation for Docker (FerretDB#2396)
15e3003 
Closes FerretDB/engineering#27.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AlekSi @fenogentov
Improve documentation for Docker (FerretDB#2396)
8933f88 
Closes FerretDB/engineering#27.
fenogentov pushed a commit to fenogentov/FerretDB that referenced this pull request Apr 20, 2023
@AlekSi @fenogentov
Improve documentation for Docker (FerretDB#2396)
d1c268d 
Closes FerretDB/engineering#27.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ptrfarkas ptrfarkas ptrfarkas approved these changes

@noisersup noisersup noisersup approved these changes

@KrishnaSindhur KrishnaSindhur KrishnaSindhur left review comments

@rumyantseva rumyantseva Awaiting requested review from rumyantseva

Assignees

@AlekSi AlekSi

Labels
documentation Something user-visible is badly or not documented trust PRs that can access Actions secrets
Projects
Current Engineering
Archived in project
Milestone
v1.1.0
Development

Successfully merging this pull request may close these issues.
5 participants
@AlekSi @rumyantseva @KrishnaSindhur @noisersup @ptrfarkas