Page MenuHomePhorge

Add small documentation details
ClosedPublic

Authored by valerio.bozzolan on Feb 9 2023, 17:19.
Tags
None
Referenced Files
F2055908: D25064.id.diff
Thu, Mar 28, 00:51
F2054651: D25064.diff
Wed, Mar 27, 18:44
F2053432: D25064.id310.diff
Wed, Mar 27, 13:05
Unknown Object (File)
Tue, Mar 26, 20:37
Unknown Object (File)
Tue, Mar 26, 14:31
Unknown Object (File)
Sun, Mar 24, 05:44
Unknown Object (File)
Thu, Mar 21, 05:51
Unknown Object (File)
Wed, Mar 20, 18:21

Details

Summary

Add some small Diviner documentation details like:

  • mention PHP 8.1 (thanks https://we.phorge.it/Q18)
  • mention the fact that you need multiple databases (it may be not obvious from the startup)
  • mention MariaDB and not just MySQL (thanks MariaDB community!)
  • mention "Administrator" and not just "User" for the "Instructions for installing, configuring, and using Phorge."

I was not bold enough to do more changes.

Test Plan

I tested locally and Diviner does not look bad.

Diff Detail

Repository
rP Phorge
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

  • mention "Administrator" and not just "User" (not just end-users)
valerio.bozzolan retitled this revision from add more documentation details to Add small documentation details.Feb 9 2023, 17:24
valerio.bozzolan edited the summary of this revision. (Show Details)

This is just a small change but if you want a spoiler, here how it looks like:

Diviner proposed home.png (350×877 px, 43 KB)

Note the first section, that now it's not just for "Users" but it also mentions "Administrator".

(I know that an "administrator" is a kind of "user", but some administrators never read "user documentation", and that's why I think this small change could somehow better orient prominently).

avivey added inline comments.
src/docs/user/installation_guide.diviner
81–83

Is there a way to phrase this it can't be understood as "multiple mysql servers"? This term-overloading always bugged me.

  • rephrase sentence with tip from avivey

I've done my best to rephrase that. Thanks @avivey

  • rephrase also the other sentence with tip from avivey
This revision is now accepted and ready to land.Feb 10 2023, 21:40

(If I remember correctly the rules we set for rP, you should be able to arc land all of these now)

This revision was automatically updated to reflect the committed changes.