Correct partitions formatting section in mirroring policy documentation #2842
Conversation
Added detailed formatting guidelines for partitions in the alter-merge-mirroring-policy-command documentation.
|
@natinimni : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 393794a: ✅ Validation status: passed
For more details, please refer to the build report. |
|
@spelluru - Could you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
bot
added
the
aq-pr-triaged
There was a problem hiding this comment.
Pull request overview
Updates the .alter-merge table policy mirroring command reference to document how to format the partition by clause directly in the page (instead of relying on a shared include), aiming to clarify partition syntax for mirroring policies.
Changes:
- Replaced the shared
[!INCLUDE]“Partitions formatting” snippet with an inlined “## Partitions formatting” section. - Added a table describing supported partition syntax forms and links to relevant Kusto functions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |Partition Type|Syntax|Notes| | ||
| |--|--|--| | ||
| |String column value|*PartitionName* `:` `string` `=` *ColumnName*|| | ||
| |Truncated datetime column (value)|*PartitionName* `:` `datetime` `=` (`startofyear` \| `startofmonth` \| `startofweek` \| `startofday`) `(` *ColumnName* `)`|See documentation on [startofyear](../query/startofyear-function.md), [startofmonth](../query/startofmonth-function.md), [startofweek](../query/startofweek-function.md), or [startofday](../query/startofday-function.md) functions.| |
There was a problem hiding this comment.
The inlined partitions formatting table doesn’t match the previously included shared content: it omits entries like “Virtual column” and “String column value hash()” that are currently shown on other pages via the include. This creates conflicting guidance for the same partition by syntax across the docs set. Either add the missing rows here or adjust the shared include (or introduce a mirroring-specific include) so the supported partition types are documented consistently.
| |--|--|--| | ||
| |String column value|*PartitionName* `:` `string` `=` *ColumnName*|| | ||
| |Truncated datetime column (value)|*PartitionName* `:` `datetime` `=` (`startofyear` \| `startofmonth` \| `startofweek` \| `startofday`) `(` *ColumnName* `)`|See documentation on [startofyear](../query/startofyear-function.md), [startofmonth](../query/startofmonth-function.md), [startofweek](../query/startofweek-function.md), or [startofday](../query/startofday-function.md) functions.| | ||
| |Truncated Datetime Column Value `=` `bin` `(` *ColumnName* `,` *TimeSpan* `)`|Read more about the [bin](../query/bin-function.md) function.|| |
There was a problem hiding this comment.
The bin() row in the partitions formatting table is malformed: the first cell currently contains a mix of “Partition Type” and syntax, and the syntax doesn’t include the partition name/type prefix (consistent with the rows above). This will render confusingly and may break the table layout. Please split this into the 3 intended columns (Partition Type / Syntax / Notes) and align the syntax pattern with the other entries (including PartitionName and the datetime = ... form).
| ## Partitions formatting | ||
|
|
||
| The partitions list is any combination of partition columns, specified using one of the forms shown in the following table. | ||
|
|
There was a problem hiding this comment.
This section inlines partitions formatting that previously came from a shared include (../includes/partitions-formatting.md), which is still used by other docs (for example, management/mirroring-policy.md). Duplicating the content here increases the chance the formatting guidance drifts between pages. Consider restoring the include (and updating the include itself if the guidance needs correction), or creating a mirroring-specific include and using it consistently across mirroring docs.
|
#sign-off |
Add documentation for partitions formatting in Kusto.
|
Learn Build status updates of commit bdbe451: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
Updated partitions formatting section with include directive and removed old formatting details.
|
Learn Build status updates of commit cf627c7: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
|
Learn Build status updates of commit 393b88e: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
|
@natinimni - Thanks for updating the content. Please let me know when you are done and I will sign off on the PR. For the next time, please use the private repository (dataexplorer-docs**-pr**) to update the content next time so that you get a few useful reports and a staging link in the PR. Please contact me (spelluru) if you don't have access to the private repository and I will send you instructions to get the access. Thanks. |
|
#sign-off |
|
Invalid command: '#sign-off'. Only the assigned author of one or more file in this PR can sign off. @spelluru |
|
@ktalmor Thanks for your review. In the public repo, pull requests should be signed off by the author. @natinimni can you confirm that this ready for merge so that @spelluru can sign off? Thanks |
|
#sign-off |
|
@spelluru Include files need #hold-off |
|
Microsoft authors of articles need to make updates through the private repository, so the updates can be staged and validated by current validation rules. After you review staging and fix all validation issues, you can add the sign-off comment to let the PR reviewers know the updates are ready to be merged. It's easy to access the private repo version of your articles in GitHub. Just add -pr to the URL, as follows: Public repo URL: We have closed this pull request. Please resubmit the updates through the private repo. For more information, see the contributor guide. |
|
Learn Build status updates of commit 9706641: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
|
@natinimni - Please see the comment above from prmerger-automator. @ttorble - Could you merge the PR for this time? Thanks. |
5 participants
Added detailed formatting guidelines for partitions in the alter-merge-mirroring-policy-command documentation.
Thank you for contributing to Kusto documentation
Please add a brief comment outlining the purpose of this PR. Add links to any relevant references such as DevOps work items.
Make sure you've done the following:
Acrolinx: Make sure your Acrolinx score is at least 80 (higher is better) and with 0 spelling issues.
Successful build: Review the build status to make sure all files are green (Succeeded) and there are no errors, warnings, or suggestions.
Preview the pages: Click each Preview URL link, scan the entire page looking for formatting issues, in particular the parts you edited.
Check the Table of Contents: If you're adding a new markdown file, make sure it is linked from the table of contents.
Sign off: Once the PR is finalized, add a comment with
#sign-off. If you need to cancel the sign-off, add a comment with#hold-off.NOTE: Signing off means the document can be published at any time.
Next steps
Learn more about how to contribute