Page MenuHomePhorge
Differential D25064

Add small documentation details
ClosedPublic
Actions

Authored by valerio.bozzolan on Feb 9 2023, 17:19.

Details

Reviewers
avivey
Group Reviewers
O1: Blessed Committers
Commits
rP20fb93d1a4be: Add small documentation 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
Branch
diviner-php-version
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 109
Build 109: arc lint + arc unit

Event Timeline

valerio.bozzolan created this revision.Feb 9 2023, 17:19
Owners added a reviewer: O1: Blessed Committers.Feb 9 2023, 17:19
Herald added subscribers: Cigaryno, Matthew, tobiaswiese, speck. · View Herald TranscriptFeb 9 2023, 17:19
valerio.bozzolan requested review of this revision.Feb 9 2023, 17:19
Harbormaster completed remote builds in B108: Diff 309.Feb 9 2023, 17:19
valerio.bozzolan updated this revision to Diff 310.Feb 9 2023, 17:21
  • mention "Administrator" and not just "User" (not just end-users)
Harbormaster completed remote builds in B109: Diff 310.Feb 9 2023, 17:21
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)
valerio.bozzolan added a comment.Feb 9 2023, 17:30

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).

valerio.bozzolan mentioned this in Q18: Lowest and Highest supported PHP (Answer 14).Feb 9 2023, 17:31
avivey subscribed.Feb 9 2023, 19:37
avivey added inline comments.
src/docs/user/installation_guide.diviner
81

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

valerio.bozzolan updated this revision to Diff 311.Feb 9 2023, 20:13
  • rephrase sentence with tip from avivey
Harbormaster completed remote builds in B110: Diff 311.Feb 9 2023, 20:13
valerio.bozzolan marked an inline comment as done.Feb 9 2023, 20:14

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

valerio.bozzolan updated this revision to Diff 312.Feb 9 2023, 20:15
  • rephrase also the other sentence with tip from avivey
Harbormaster completed remote builds in B111: Diff 312.Feb 9 2023, 20:15
avivey accepted this revision.Feb 10 2023, 21:40
This revision is now accepted and ready to land.Feb 10 2023, 21:40
avivey added a comment.Feb 10 2023, 21:41

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

Closed by commit rP20fb93d1a4be: Add small documentation details. · Explain WhyFeb 11 2023, 10:10
This revision was automatically updated to reflect the committed changes.
valerio.bozzolan added a commit: rP20fb93d1a4be: Add small documentation details.

Revision Contents
Changeset List

Diff 310

View Options

src/docs/book/user.book

Loading...
View Options

src/docs/user/configuration/configuration_guide.diviner

Loading...
View Options

src/docs/user/installation_guide.diviner

Loading...
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0