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

Update assessment.md - FINAL Submission by Tamara Fine Skversky #2480

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

TFS-82
Copy link

@TFS-82 TFS-82 commented Dec 10, 2024

Here is a summary of the changes I made to this article (spanning two separate change commits):
Title changed for clarity
Beneath Title Added "applies to" links at the top, which I saw in other articles and made sense here as well.

Intro: I trimmed it down significantly, and tried to remove jargon that seemed extraneous. I also employed content reuse, by taking some text from an existing article, and applying it here. It was preferable to the text that was in this version. I did make some light edits to the "lifted" text however.

Body of article:

  • Reordered the content, adding headings and subheadings, blockquotes (notes), code script, bullets, and so on where it seemed to improve clarity.
  • Removed details about management commands, as it seemed like a diversion from the main focus of the article. I instead put a link to more information about management commands in the references at the bottom.
  • Added bullets to the links in the KQL in other services
  • Corrected the References section title at the bottom, and at least 1 spelling error in one of the links. I also reordered these links slightly, in the hopes that it was a more intuitive order.
  • In "Types of query statements", I added info I found in my research about the two types of statements... but tried to maintain focus in the article on the three (not two) types of user query statements.
  • Added some helper text introducing the example, and added a heading to that section as well, removing language that seemed too informal.

Items I would have liked to have added with more time and knowledge:

  • Concrete examples of each user query statement types.
  • A more thorough audit of the reference links, making sure anything relevant was included.

Note: I also debated about the title (using a colon, calling it "An Introduction", etc). "Overview" would have also worked, and I hesitated about capitalizing the word "An" after the intro, given sentence case convention.

In any case, I hope this submission meets your standards. Thank you so much for the opportunity.

-preliminary changes only-
Copy link
Contributor

Learn Build status updates of commit 28fed1c:

⚠️ Validation status: warnings

File Status Preview URL Details
data-explorer/kusto/query/assessment.md ⚠️Warning Details

data-explorer/kusto/query/assessment.md

  • Line 24, Column 39: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#user-query-statements' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 25, Column 119: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#application-query-statements' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 46, Column 69: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#tabular-data-sources' in 'query/assessment.md'.
  • Line 24, Column 39: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#user-query-statements' will be broken in isolated environments. Replace with a relative link.
  • Line 24, Column 39: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#user-query-statements
  • Line 25, Column 119: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#application-query-statements' will be broken in isolated environments. Replace with a relative link.
  • Line 25, Column 119: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#application-query-statements
  • Line 77, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Here is a summary of the changes I made to this article:
-Title: changed for clarity
-Added "applies to" links at the top, which I saw in other articles and made sense here as well.
-Intro: I trimmed it down significantly, and tried to remove jargon that seemed extraneous.  I also employed content reuse, by taking some text from an existing article, and applying it here.  It was preferable to the text that was in this version.  I did make some light edits to the "lifted" text however.
-Body of article: 
1. I reordered the content, adding headings and subheadings, blockquotes (notes), code script, bullets, and so on where it seemed to improve clarity.  
2. I removed details about management commands, as it seemed like a diversion from the main focus of the article.  I instead put a link to more information about management commands in the references at the bottom.
3. I added bullets to the links in the KQL in other services
4. I corrected the References section title at the bottom, and at least 1 spelling error in one of the links.  I also reordered these links slightly, in the hopes that it was a more intuitive order.
5. In Types of query statements, I added info I found in my research about the two types of statements... but tried to maintain focus in the article on the three (not two) types of user query statements.
6. I added some helper text introducing the example, and added a heading to that section as well, removing language that seemed too informal.

Items I would have liked to have added with more time and knowledge:
-Concrete examples of each user query statement types
-A more thorough audit of the reference links, making sure anything relevant was included.

Thank you for the opportunity.
Update assessment.md - Submission by Tamara
Copy link
Contributor

Learn Build status updates of commit 35e3775:

⚠️ Validation status: warnings

File Status Preview URL Details
data-explorer/kusto/query/assessment.md ⚠️Warning Details

data-explorer/kusto/query/assessment.md

  • Line 24, Column 39: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#user-query-statements' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 25, Column 119: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#application-query-statements' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 24, Column 39: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#user-query-statements' will be broken in isolated environments. Replace with a relative link.
  • Line 24, Column 39: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#user-query-statements
  • Line 25, Column 119: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#application-query-statements' will be broken in isolated environments. Replace with a relative link.
  • Line 25, Column 119: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://learn.microsoft.com/en-us/kusto/query/statements?view=azure-data-explorer#application-query-statements
  • Line 57, Column 1: [Suggestion: table-syntax-invalid - See documentation] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@TFS-82 TFS-82 changed the title Update assessment.md - INTERIM SAVE Update assessment.md - FINAL Submission by Tamara Fine Skversky Dec 10, 2024
@ttorble ttorble added the aq-pr-triaged tracking label for the PR review team label Dec 10, 2024
@TFS-82
Copy link
Author

TFS-82 commented Dec 10, 2024 via email

Copy link
Contributor

@TFS-82 : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@shsagir
Copy link
Collaborator

shsagir commented Dec 11, 2024

#hold-off

Copy link
Contributor

You typed hold-off, but the PR wasn't signed off, so nothing was changed.

@TFS-82
Copy link
Author

TFS-82 commented Dec 11, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants