[PR #12] [MERGED] docs: comprehensive audit and update of all documentation #44

New issue

Closed

opened 2026-06-08 09:15:48 +00:00 by ryangr0 · 0 comments

ryangr0 commented 2026-06-08 09:15:48 +00:00

Owner

Copy link

📋 Pull Request Information

Original PR: https://github.com/webgrip/invoiceninja-application/pull/12
Author: @Copilot
Created: 11/16/2025
Status: ✅ Merged
Merged: 11/23/2025
Merged by: @Ryangr0

Base: main ← Head: copilot/update-documentation-links

---

📝 Commits (8)

• 4e9fe20 Initial plan
• 83a0fc3 docs: fix broken external documentation links
• 0ac2325 docs: add version matrix, hardening checklist, and deployment scenarios
• c888a9f docs: fix last broken Docker documentation link
• afd3afe Merge branch 'main' into copilot/update-documentation-links
• 0fa3f67 docs: update Invoice Ninja version to 5.12.33 and refresh all retrieval dates
• b5c199e docs: Don't opine passsword
• f0b6635 docs: Give two options to use env vars for mariadb password

📊 Changes

8 files changed (+368 additions, -35 deletions)

View changed files

📝 docs/techdocs/docs/configuration/environment-variables.md (+2 -2)
📝 docs/techdocs/docs/configuration/services.md (+4 -4)
📝 docs/techdocs/docs/deployment.md (+96 -3)
📝 docs/techdocs/docs/development.md (+4 -4)
📝 docs/techdocs/docs/operations.md (+5 -5)
📝 docs/techdocs/docs/project-overview.md (+29 -4)
📝 docs/techdocs/docs/troubleshooting.md (+221 -5)
📝 docs/techdocs/docs/upstream-application.md (+7 -8)

📄 Description

Pull Request 🚀

📌 Summary

Conducted comprehensive documentation audit: fixed 11 broken external links, added version compatibility matrix, production hardening checklist (70+ items), and 5 deployment scenario guides with complete command sequences. Re-verified after main branch merge and updated Invoice Ninja version to 5.12.33.

---

Changelog

Added

• Version Compatibility Matrix - Current component versions (Invoice Ninja 5.12.33, Nginx 1.26.2, MariaDB 11.6.2, Redis 7.4.2, PHP 8.3, Laravel 10.x) with base images, production status, and update policy
• Production Hardening Checklist - 70+ checkpoints covering pre-deployment security, database hardening, backup verification, monitoring setup, performance optimization, compliance, post-deployment validation, and maintenance schedule
• Deployment Scenarios - 5 complete guides with step-by-step commands:
  • Fresh installation on new server
  • Server migration with backup restoration
  • Version upgrade with rollback procedure
  • Database engine switching (MariaDB ↔ PostgreSQL)
  • Failed update recovery

Changed

• Updated Invoice Ninja version from 5.12.27 to 5.12.33 (synced with main branch Dockerfile updates)
• Updated Invoice Ninja documentation URLs from deprecated /en/self-host-installation/ to /en/self-host/
• Updated MariaDB URLs from /kb/en/administration/ to /kb/en/ (knowledge base root)
• Updated Redis URLs from legacy /topics/* to /docs/latest/operate/oss_and_stack/management/
• Updated PostgreSQL documentation from version-specific /docs/13/ to /docs/current/
• Updated all "Retrieved" dates to 2025-11-23 (current verification date)

Fixed

• 11 broken external documentation links across Invoice Ninja, MariaDB, Redis, PostgreSQL, and Docker documentation
• All 29 critical external links tested and verified as accessible
• Version consistency between Dockerfiles and documentation

---

✅ Checklist

• Added documentation
• Tests added / updated (N/A - documentation only)

Original prompt

Go through the docs and make sure everything is still up to date. Follow all links to make sure they are still available. Fill any missing information.

Created from VS Code via the GitHub Pull Request extension.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

---

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/webgrip/invoiceninja-application/pull/12 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 11/16/2025 **Status:** ✅ Merged **Merged:** 11/23/2025 **Merged by:** [@Ryangr0](https://github.com/Ryangr0) **Base:** `main` ← **Head:** `copilot/update-documentation-links` --- ### 📝 Commits (8) - [`4e9fe20`](https://github.com/webgrip/invoiceninja-application/commit/4e9fe204b768e7e2122ada96b367d7020ab36e32) Initial plan - [`83a0fc3`](https://github.com/webgrip/invoiceninja-application/commit/83a0fc31e8fbece06a502e80fdd7e4e1b2e11fee) docs: fix broken external documentation links - [`0ac2325`](https://github.com/webgrip/invoiceninja-application/commit/0ac2325da573d37f3b7b37480e3e73059da26728) docs: add version matrix, hardening checklist, and deployment scenarios - [`c888a9f`](https://github.com/webgrip/invoiceninja-application/commit/c888a9fb25e8af616db3ac3fe687ce8c0a3841a2) docs: fix last broken Docker documentation link - [`afd3afe`](https://github.com/webgrip/invoiceninja-application/commit/afd3afefc264cc950125d231c887f722f95e9ae5) Merge branch 'main' into copilot/update-documentation-links - [`0fa3f67`](https://github.com/webgrip/invoiceninja-application/commit/0fa3f6767b3539abe9de32db217e20279221ab7a) docs: update Invoice Ninja version to 5.12.33 and refresh all retrieval dates - [`b5c199e`](https://github.com/webgrip/invoiceninja-application/commit/b5c199e7b0e6898f3f4ba24e2a2b61a110760c10) docs: Don't opine passsword - [`f0b6635`](https://github.com/webgrip/invoiceninja-application/commit/f0b6635454ab08b3c2252c78c0f72ec255bb939b) docs: Give two options to use env vars for mariadb password ### 📊 Changes **8 files changed** (+368 additions, -35 deletions) <details> <summary>View changed files</summary> 📝 `docs/techdocs/docs/configuration/environment-variables.md` (+2 -2) 📝 `docs/techdocs/docs/configuration/services.md` (+4 -4) 📝 `docs/techdocs/docs/deployment.md` (+96 -3) 📝 `docs/techdocs/docs/development.md` (+4 -4) 📝 `docs/techdocs/docs/operations.md` (+5 -5) 📝 `docs/techdocs/docs/project-overview.md` (+29 -4) 📝 `docs/techdocs/docs/troubleshooting.md` (+221 -5) 📝 `docs/techdocs/docs/upstream-application.md` (+7 -8) </details> ### 📄 Description # Pull Request 🚀 ## 📌 Summary Conducted comprehensive documentation audit: fixed 11 broken external links, added version compatibility matrix, production hardening checklist (70+ items), and 5 deployment scenario guides with complete command sequences. Re-verified after main branch merge and updated Invoice Ninja version to 5.12.33. --- ## Changelog ### Added - **Version Compatibility Matrix** - Current component versions (Invoice Ninja 5.12.33, Nginx 1.26.2, MariaDB 11.6.2, Redis 7.4.2, PHP 8.3, Laravel 10.x) with base images, production status, and update policy - **Production Hardening Checklist** - 70+ checkpoints covering pre-deployment security, database hardening, backup verification, monitoring setup, performance optimization, compliance, post-deployment validation, and maintenance schedule - **Deployment Scenarios** - 5 complete guides with step-by-step commands: - Fresh installation on new server - Server migration with backup restoration - Version upgrade with rollback procedure - Database engine switching (MariaDB ↔ PostgreSQL) - Failed update recovery ### Changed - Updated Invoice Ninja version from 5.12.27 to 5.12.33 (synced with main branch Dockerfile updates) - Updated Invoice Ninja documentation URLs from deprecated `/en/self-host-installation/` to `/en/self-host/` - Updated MariaDB URLs from `/kb/en/administration/` to `/kb/en/` (knowledge base root) - Updated Redis URLs from legacy `/topics/*` to `/docs/latest/operate/oss_and_stack/management/` - Updated PostgreSQL documentation from version-specific `/docs/13/` to `/docs/current/` - Updated all "Retrieved" dates to 2025-11-23 (current verification date) ### Fixed - 11 broken external documentation links across Invoice Ninja, MariaDB, Redis, PostgreSQL, and Docker documentation - All 29 critical external links tested and verified as accessible - Version consistency between Dockerfiles and documentation --- ## ✅ Checklist - [x] Added documentation - [ ] Tests added / updated (N/A - documentation only) <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > Go through the docs and make sure everything is still up to date. Follow all links to make sure they are still available. Fill any missing information. </details> Created from VS Code via the [GitHub Pull Request](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension. <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --- _{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

ryangr0 2026-06-08 09:15:48 +00:00

• closed this issue
• added the
  pull-request
  label

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

renovate/webgrip-workflows-digest

renovate/nginx-1.x

renovate/invoiceninja-invoiceninja-5.x

renovate/redis-8.x

renovate/postgres-18.x

renovate/mariadb-12.x

renovate/postgres-17.x

renovate/mariadb-11.x

renovate/redis-7.x

renovate/nginxinc-nginx-unprivileged-1.x

gh-pages

1.0.74

1.0.73

1.0.72

1.0.71-rc.1

1.0.71

1.0.70

1.0.70-dev.1

1.0.69

1.0.68

1.0.67

1.0.67-dev.1

1.0.66

1.0.65-dev.2

1.0.65

1.0.65-dev.1

1.0.64

1.0.63

1.0.62

1.0.62-dev.1

1.0.61

1.0.61-dev.1

1.0.60

1.0.59

1.0.59-dev.1

1.0.58

1.0.57

1.0.57-dev.1

1.0.56

1.0.56-dev.1

1.0.55

1.0.55-dev.1

1.0.54

1.0.54-dev.1

1.0.53-dev.1

1.0.53

1.0.52

1.0.51

1.0.50

1.0.49

1.0.48

1.0.47

1.0.46

1.0.45

1.0.44

1.0.43

1.0.42

1.0.41

1.0.40

1.0.39

1.0.38

1.0.37

1.0.36

1.0.35

1.0.34

1.0.33

1.0.32

1.0.31

1.0.30

1.0.29

1.0.28

1.0.27

1.0.26

1.0.25

1.0.24

1.0.23

1.0.22

1.0.21

1.0.20

1.0.19

1.0.18

1.0.17

1.0.16

1.0.15

1.0.14

1.0.13

1.0.12

1.0.11

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Labels

Clear labels   

pull-request

Mirrored from GitHub Pull Request

No labels

pull-request

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

webgrip/invoiceninja-application#44

No description provided.