Update documents in preparation of v2024.2#1332
Conversation
| Global cache is a feature that can be enabled in Zonemaster-Engine and consists | ||
| in a shared, persistent cache. It can increase the performance when many tests | ||
| are run within a short time frame. See [global cache configuration]. |
There was a problem hiding this comment.
I suggest that we have the same wording in Engine and Backend. I only updated in Backend.
There was a problem hiding this comment.
You mean this wording? If so then I don't think it applies since Engine can be used without Backend.
zonemaster/docs/public/installation/zonemaster-backend.md
Lines 818 to 821 in b2acd35
There was a problem hiding this comment.
I think it could be much shorter in the Engine installation instruction, just as in the Backend installation instruction. But if it should be more detailed it should be so in both places. Or actually in all three places, because there is text in the CLI installation instructions too https://github.com/zonemaster/zonemaster/blob/develop/docs/public/installation/zonemaster-cli.md#global-cache
There was a problem hiding this comment.
I don't think it's much of an issue. Having it slightly different (i.e more generic) in the Engine installation instructions does not do any real harm, moreover the description is a better fit to the component (Engine) since it has no notion of batch and could be used with other interfaces than Zonemaster-{CLI, Backend}. The same idea is conveyed, and all references to the global cache end up in pointing to the same configuration document.
There was a problem hiding this comment.
I think that shorter text is better. No need for longer text when there a separate document.
| ``` | ||
|
|
||
| 3. Make sure Zonemaster LDNS was properly installed. | ||
| 4. Make sure Zonemaster LDNS was properly installed. |
There was a problem hiding this comment.
On lines 61 it refers to CentOS.
I think 2.2 should refer to the installation instructions with the commet that Zonemaster::LDNS etc are replaced by the dist files.
There was a problem hiding this comment.
I don't follow, could you explain again?
There was a problem hiding this comment.
On line 61 there is a reference to CentOS that we do no support any more.
In section 2.2 there are too much details about installation. We should just follow the normal installation so 2.2 could be much shorter. Exception is that we should use dist file when installing with cpanm. And preliminary zip for GUI.
- Remove CentOS related documentation - Update Zonemaster-LDNS section in SystemTesting document - Other minor fixes
| 2. Install the preliminary distribution tarball for zonemaster-ldns. | ||
|
|
||
| ```sh | ||
| sudo cpanm Zonemaster-LDNS-${LDNS_VERSION}.tar.gz | ||
| ``` |
There was a problem hiding this comment.
It depends on the OS, if internal LDNS should be installed or not. I think it is better to write that the installation instruction should be followed, but replaces Zonemaster::LDNS with Zonemaster-LDNS-${LDNS_VERSION}.tar.gz
matsduf
left a comment
There was a problem hiding this comment.
To be updated before next test period.
Purpose
This PR update various documents, both public and internal. Each are addressed in a different commit.
Context
Release v2024.2 testing
Changes
See commit messages.
The only change in a "public" document (1230fba) relates to removing the experimental status of the Global cache in the document, which was missed by #1303.
How to test this PR
N/A. Review, and in particular links.