Updates GUI installation and configuration documents#1442
Conversation
|
@tbleckert and @rhedman, please take a look. |
mattias-p
left a comment
There was a problem hiding this comment.
Over all I think this looks great! I've reviewed it and made comments on various things. I've limited my review to things that ChatGPT did not pick up on. I believe you'd characterize all or most of my comments as editorial.
| If this installation is an upgrade or reinstallation of Zonemaster-GUI and has | ||
| done some configuration or customization, make sure to save updated file, e.g. | ||
| `/var/www/html/zonemaster-web-gui/dist/config.json` and the `zonemaster.conf` | ||
| Apache configuration file, before removing the old version. | ||
|
|
||
| You should also consider saving the old version under a new path instead of | ||
| just removing it. | ||
|
|
||
| Else upgrading is as simple as removing the old version and installing the new | ||
| version in the same way as a new installation. |
There was a problem hiding this comment.
From my point of view, the third paragraph is the part that really belongs here. While the two first paragraphs are important, I believe users would be better served if they were converted into instructions in the "Remove old Zonemaster-GUI" sections. As far as I understand.
There was a problem hiding this comment.
I cannot see how the text can be improved.
| - [Environment Variables](configuration/backend-environment-variables.md) | ||
| - [GUI](configuration/gui.md) | ||
| - [Environment Variables](configuration/backend-environment-variables.md) |
There was a problem hiding this comment.
This change should be reverted. The document relates solely to Backend, so the indentation is needed.
There was a problem hiding this comment.
Yes, possibly (it also refer to the ZONEMASTER_RECORD environment variabl), but it is not a sub-document to the backend_config.ini configuration. We should probably have a backend subdirectory with a README file and both documents.
|
The mdbook can't be built. Can you take a look at that? |
What error did you get? Could that be due to the interaction between this PR and #1445? |
Co-authored-by: Mattias Päivärinta <mattias@paivarinta.se> Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
0f96b40 to
73e88a8
Compare
|
@mattias-p and @tgreenx, please re-review! @mattias-p, can you check if the mdbook issue is still there? |
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
d12c455 to
0d1bc05
Compare
0d1bc05 to
d9fb884
Compare
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
| * The default language must be one of the enabled languages. | ||
| * **enabledLanguages**: An array of language codes that are supported by the | ||
| application. | ||
| * The array should match the list of language codesin the [Locale setting] in |
There was a problem hiding this comment.
| * The array should match the list of language codesin the [Locale setting] in | |
| * The array should match the list of language codes in the [Locale setting] in |
| 1. `npm install` | ||
| 2. `npm run release` | ||
| 2. `npm run build` | ||
| 3. `npm run release` |
There was a problem hiding this comment.
npm run release is defined as npm run build && node scripts/create_release.js, so the npm run build command does not need to be run separately.
| npm install | ||
| npm run build | ||
| npm run release |
There was a problem hiding this comment.
npm run release is defined as npm run build && node scripts/create_release.js, so the npm run build command does not need to be run separately.
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
|
@matsduf I see unresolved conversations from @marc-vanderwal, but nothing critical so it could be merged as is. |
Purpose
This PR updates installation and configuration documents to adapt to the new GUI proposed in zonemaster/zonemaster-gui#511 (originally in zonemaster/zonemaster-gui#500).
The new documents are primarily modified versions of the documents provided in zonemaster/zonemaster-gui#511.
How to test this PR
All documents need to be reviewed and verified.