Skip to content

docs(admin): Emphasize recommended versions in db chapter #11588

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

Merged
merged 6 commits into from
Feb 27, 2024

Conversation

joshtrichards
Copy link
Member

☑️ Resolves

More strongly emphasize that picking the version of your preferred database is also important.

  • Mention it
  • Link to system requirements
  • Add a note call-out
  • Clarify the steps for db deployment as bullet points for the reader

Context: Some people merely use the latest tags their MariaDB Docker stacks or install the latest from vendor repositories without paying attention to the versions recommended by us. Not surprisingly they run into problems from time to time (like the latest breaking changes that were in MariaDB 11.3.x images -- which we don't even support since it's a short-term release).

Every little nudge in the right direction helps.

Side note: Anyone know why the Database config section isn't just a chapter under Installation and server configuration? It's kind of weird that it's arbitrarily near the end of the Admin Manual, since it's a prerequisite to any deployment.

🖼️ Screenshots

image

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards joshtrichards changed the title Docs/admin/db config versions docs(admin): Emphasize recommended versions in db chapter Feb 26, 2024
Copy link
Contributor

@kesselb kesselb left a comment

Choose a reason for hiding this comment

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

Good recommendation, Thank you 🙏

@joshtrichards
Copy link
Member Author

/backport to stable28

@joshtrichards
Copy link
Member Author

/backport to stable27

@joshtrichards joshtrichards merged commit 4fe91a6 into master Feb 27, 2024
@joshtrichards joshtrichards deleted the docs/admin/db-config-versions branch February 27, 2024 22:21
Copy link

backportbot bot commented Feb 27, 2024

The backport to stable27 failed. Please do this backport manually.

# Switch to the target branch and update it
git checkout stable27
git pull origin stable27

# Create the new backport branch
git checkout -b backport/11588/stable27

# Cherry pick the change from the commit sha1 of the change against the default branch
# This might cause conflicts, resolve them
git cherry-pick d8ad0068 14549e35 e82ff8cf 5388282a 62fba97e e67951fe

# Push the cherry pick commit to the remote repository and open a pull request
git push origin backport/11588/stable27

Error: Failed to cherry pick commits: error: no cherry-pick or revert in progress
fatal: cherry-pick failed


Learn more about backports at https://docs.nextcloud.com/server/stable/go.php?to=developer-backports.

Copy link

backportbot bot commented Feb 27, 2024

The backport to stable28 failed. Please do this backport manually.

# Switch to the target branch and update it
git checkout stable28
git pull origin stable28

# Create the new backport branch
git checkout -b backport/11588/stable28

# Cherry pick the change from the commit sha1 of the change against the default branch
# This might cause conflicts, resolve them
git cherry-pick d8ad0068 14549e35 e82ff8cf 5388282a 62fba97e e67951fe

# Push the cherry pick commit to the remote repository and open a pull request
git push origin backport/11588/stable28

Error: Failed to cherry pick commits: error: no cherry-pick or revert in progress
fatal: cherry-pick failed


Learn more about backports at https://docs.nextcloud.com/server/stable/go.php?to=developer-backports.

@zmweske
Copy link

zmweske commented Mar 16, 2024

should the mariadb version include v10.6? That is what is listed under https://github.com/nextcloud/docker?tab=readme-ov-file#running-this-image-with-docker-compose

@nickvergessen
Copy link
Member

@zmweske
Copy link

zmweske commented Mar 17, 2024

Ok, it looks like it was updated since posting the comment:
(image)
Just wanted to make sure that things were consistent and made sense

@zmweske
Copy link

zmweske commented Mar 17, 2024

Looks like it is more updated now:
image

@nickvergessen
Copy link
Member

9791035 2 months ago, but all good

@zmweske
Copy link

zmweske commented Mar 17, 2024

Oh it looks like they are both listed as latest, even though one is definitely not. I'll post the links when I get back to my comp

@zmweske
Copy link

zmweske commented Mar 18, 2024

Yeah, the problem was that both the page title and the menu in the bottom right said latest when it was not: https://docs.nextcloud.com/server/21/admin_manual/installation/system_requirements.html (obv v21 when looking through the url)

@joshtrichards
Copy link
Member Author

@zmweske Indeed. Been attempting to fix that (e.g. #11628), but it's a work in progress still. :)

@zmweske
Copy link

zmweske commented Mar 18, 2024

No worries, been there hahaha

acataluddi pushed a commit to acataluddi/nextcloud-documentation that referenced this pull request Apr 28, 2024
…11588)

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Adriano Cataluddi <acataluddi@gmail.com>
Copy link
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants