Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of global cache #1227

Merged
merged 4 commits into from
Dec 4, 2023

Conversation

matsduf
Copy link
Contributor

@matsduf matsduf commented Dec 1, 2023

Purpose

Global cache feature has bee added to Zonemaster-Engine as an experimental feature. This PR adds documentation for the users how to enable and use the feature. Instructions for Rocky Linux is still missing.

Context

zonemaster/zonemaster-engine#1201

Changes

A new document plus a reference from the installation document.

How to test this PR

Review and follow the instructions.

@matsduf matsduf added the A-Documentation Area: Documentation only. label Dec 1, 2023
@matsduf matsduf added this to the v2023.2 milestone Dec 1, 2023
@matsduf
Copy link
Contributor Author

matsduf commented Dec 1, 2023

@pnax, please verify that everything is correct.

ghost
ghost previously approved these changes Dec 4, 2023
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks for the documentation update.

To enable global caching, additional software has to be installed and custom
profile has to be created, where global caching is enabled.

Since it is an experimental featuer, its interface might change in upcoming
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: featuer -> feature

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

## Enable global cache

Update `profile.json` in `/etc/zonemaster` (or `/usr/local//etc/zonemaster`) by
addin the following section,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: addin -> adding

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@matsduf matsduf requested a review from a user December 4, 2023 11:18
@matsduf
Copy link
Contributor Author

matsduf commented Dec 4, 2023

@pnax, please re-approve.

tgreenx
tgreenx previously approved these changes Dec 4, 2023
docs/public/configuration/global-cache.md Outdated Show resolved Hide resolved
ghost
ghost previously approved these changes Dec 4, 2023
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
@matsduf matsduf dismissed stale reviews from ghost and tgreenx via 19e1ace December 4, 2023 13:20
@matsduf
Copy link
Contributor Author

matsduf commented Dec 4, 2023

Included minor correction by @tgreenx. Please re-approve, @pnax and @tgreenx

@matsduf matsduf merged commit 5b7a90c into zonemaster:develop Dec 4, 2023
@matsduf matsduf deleted the document-redis-cache branch December 4, 2023 21:25
@matsduf
Copy link
Contributor Author

matsduf commented Mar 17, 2024

Release testing: Minor issues found in the document. Those are corrected by #1240.

@matsduf matsduf added the S-ReleaseTested Status: The PR has been successfully tested in release testing label Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation only. S-ReleaseTested Status: The PR has been successfully tested in release testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants