Updates Backend usage documents and makes global cache unexperimental#1303
Merged
Conversation
This was referenced Oct 30, 2024
tgreenx
reviewed
Nov 7, 2024
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
* Editorial changes from review comments. * Other changes from review comments. * Renamed the "using RPCAPI" file to get consistent naming. * Added text on adding batch from a file with zmb(). * Added comments on IDN domain names.
mattias-p
reviewed
Nov 8, 2024
mattias-p
left a comment
Member
There was a problem hiding this comment.
So far I haven't looked at all at Using-Zonemaster-Backend-RPCAPI.md, and I've only got half way through Using-Zonemaster-Backend-for-batch-testing.md.
Regarding Using-Zonemaster-Backend-for-batch-testing.md I think the outline is excellent! But I have lots of comments on little language things.
Co-authored-by: Mattias Päivärinta <mattias@paivarinta.se>
tgreenx
previously approved these changes
Nov 12, 2024
mattias-p
reviewed
Nov 12, 2024
Co-authored-by: Mattias Päivärinta <mattias@paivarinta.se>
mattias-p
previously approved these changes
Nov 12, 2024
mattias-p
left a comment
Member
There was a problem hiding this comment.
I think it's great to get some how-to guides, and in particular it's great to have documentation on batching.
I found a few tiny nits in the remainder of the PR that I didn't look through before, but all in all this is great to have.
| To get a more readable output, pipe the command through `jq`: | ||
|
|
||
| ```sh | ||
| zmb version_info | jq |
Member
There was a problem hiding this comment.
Maybe it would be helpful to use the -S option for jq in our options. That way you get more stable outputs when copying commands from our documentation.
Contributor
Author
There was a problem hiding this comment.
Good suggestion, but in next iteration.
Contributor
Author
|
@mattias-p, @tgreenx och @matsstralbergiis, please re-review. |
mattias-p
previously approved these changes
Nov 12, 2024
mattias-p
left a comment
Member
There was a problem hiding this comment.
I only found a missing capitalization.
tgreenx
previously approved these changes
Nov 12, 2024
…esting.md Co-authored-by: Mattias Päivärinta <mattias@paivarinta.se>
This was referenced Dec 4, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
The main purpose of this PR is to create a document for Backend batch usage. As a result of the work the following updates are proposed:
zmbandzmtestinstead ofcurl.Context
Decision on F2F to document running batches.
PR will be created in Engine to make global cache unexperimental.
How to test this PR
Review and comment. Anything missing?