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 deb and rpm installation docs #4927

Merged
merged 13 commits into from
Mar 21, 2025
Merged

Conversation

Fashander
Copy link
Member

@Fashander Fashander commented Mar 14, 2025

Description

Closes #4921.

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 the documentation Something user-visible is badly or not documented label Mar 14, 2025
@Fashander Fashander added this to the Next milestone Mar 14, 2025
@Fashander Fashander self-assigned this Mar 14, 2025
@Fashander Fashander marked this pull request as ready for review March 15, 2025 01:54
@Fashander Fashander requested a review from AlekSi as a code owner March 15, 2025 01:54
@Fashander Fashander requested review from a team, chilagrow and noisersup March 15, 2025 01:54
@Fashander Fashander added the trust PRs that can access Actions secrets label Mar 15, 2025
@Fashander Fashander enabled auto-merge (squash) March 15, 2025 01:54
@chilagrow chilagrow added not ready Issues that are not ready to be worked on; PRs that should skip CI and removed not ready Issues that are not ready to be worked on; PRs that should skip CI labels Mar 17, 2025
chilagrow
chilagrow previously approved these changes Mar 17, 2025

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the installation documentation for FerretDB’s DEB and RPM packages by adding clearer descriptions of the development and production packages.

  • Added descriptive details and a note block explaining package suffixes for both RPM and DEB packages.
  • Improved wording for download instructions in the DEB documentation.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
website/docs/installation/ferretdb/rpm.md Added package differentiation details and note block.
website/docs/installation/ferretdb/deb.md Added package differentiation details and improved download instructions.
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.

Please do the self-review first, and please re-read the issue

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the installation documentation for FerretDB and DocumentDB using both .deb and .rpm packages, as well as Docker images. The changes clarify the availability of production and development packages and update the deployment instructions across several docs files.

  • Updated instructions for downloading and installing .rpm packages for FerretDB.
  • Revised the .deb package installation docs for both DocumentDB and FerretDB.
  • Refined the descriptions for Docker image deployments for DocumentDB and FerretDB.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
website/docs/installation/ferretdb/rpm.md Updated instructions for FerretDB .rpm installation
website/docs/installation/documentdb/deb.md Revised DocumentDB .deb installation details
website/docs/installation/ferretdb/deb.md Clarified FerretDB .deb package download instructions
website/docs/installation/documentdb/docker.md Adjusted Docker image bullet list presentation
website/docs/installation/ferretdb/docker.md Refined Docker image descriptions

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Fashander Fashander had a problem deploying to cloudflare-dev-docs March 19, 2025 15:21 — with GitHub Actions Failure
Co-authored-by: Alexey Palazhchenko <alexey.palazhchenko@ferretdb.io>

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the installation documentation for both DocumentDB and FerretDB by providing clearer instructions and differentiating between production and development packages for Debian, RPM, and Docker deployments.

  • Updated DocumentDB installation instructions for .deb packages.
  • Refined FerretDB installation steps for .deb and .rpm packages.
  • Revised Docker installation documentation for both DocumentDB and FerretDB.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/docs/installation/documentdb/deb.md Revised instructions for DocumentDB .deb packages with separate guidance for production and development.
website/docs/installation/ferretdb/deb.md Updated FerretDB .deb package instructions to highlight production vs. development packages and installation steps.
website/docs/installation/ferretdb/rpm.md Modified FerretDB .rpm package instructions to include production and development package details.
website/docs/installation/documentdb/docker.md Clarified Docker image descriptions for production and development deployments.
website/docs/installation/ferretdb/docker.md Improved clarity of Docker image usage instructions and cross-referenced evaluation image documentation.
website/docs/installation/evaluation.md Simplified reference to the evaluation image for quick testing and experiments.
Comments suppressed due to low confidence (2)

website/docs/installation/ferretdb/deb.md:16

  • [nitpick] Consider ending this sentence with a period instead of a comma to enhance punctuation consistency.
Download the appropriate FerretDB `.deb` package from our release page,

website/docs/installation/ferretdb/rpm.md:16

  • [nitpick] Consider ending this sentence with a period instead of a comma for improved clarity.
Download the appropriate FerretDB `.rpm` package from our release page,
@Fashander Fashander merged commit 4d0e2eb into FerretDB:main Mar 21, 2025
24 checks passed
@Fashander Fashander deleted the recommend branch March 21, 2025 10:35
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
Status: Done
Development

Successfully merging this pull request may close these issues.

Make it harder for users to use development builds by accident
4 participants