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

Improving follower documentation #2378

Conversation

guimatheus92
Copy link
Contributor

@guimatheus92 guimatheus92 commented Sep 3, 2024

Thank you for contributing to Azure Data Explorer documentation

Fill out these items before submitting your pull request:

If you are working internally at Microsoft:

  • Provide a link to an Azure DevOps Boards work item that tracks this feature/update.

    • I work internaly Microsoft, but there is no link.
  • Who is your Docs team contact?

For internal Microsoft contributors, check off these quality control items as you go

  • 1. Check the Acrolinx report: Make sure your Acrolinx Total score is above 80 minimum (higher is better) and with no spelling issues. Acrolinx ensures we are providing consistent terminology and using an appropriate voice and tone, and helps with localization.

  • 2. Successful build with no warnings or suggestions: Review the build status to make sure all files are green (Succeeded).

  • 3. Preview the pages:: Click each Preview URL link to view the rendered HTML pages on the review.learn.microsoft.com site to check the formatting and alignment of the page. Scan the page for overall formatting, and look at the parts you edited in detail.

  • 4. Check the Table of Contents: If you are adding a new markdown file, make sure it is linked from the table of contents.

  • 5. #sign-off to request PR review and merge: Once the pull request is finalized and ready to be merged, indicate so by typing #sign-off in a new comment in the Pull Request. If you need to cancel that sign-off, type #hold-off instead. Signing off means the document can be published at any time. Note, this is a formatting and standards review, not a technical review.

Merge and publish

  • After you #sign-off, there is a separate PR Review team that will review the PR and describe any necessary feedback before merging.
  • The review team will use the comments section in the PR to provide feedback if changes are needed. Address any blocking issues and sign off again to request another review.
  • Once all feedback is resolved, you can #sign-off again. The PR Review team reviews and merges the pull request into the specified branch (usually the *main( branch or a release-branch).
  • From the main branch, the change is merged into the live branch several times a day to publish it to the public learn.microsoft.com site.

Copy link
Contributor

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

1 similar comment
Copy link
Contributor

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

Copy link
Contributor

Learn Build status updates of commit f7d584c:

✅ Validation status: passed

File Status Preview URL Details
data-explorer/follower.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@Court72
Copy link
Contributor

Court72 commented Sep 3, 2024

@shsagir

Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label Sep 3, 2024
@guimatheus92
Copy link
Contributor Author

#sign-off

@Court72 done, thanks!

Copy link
Contributor

Invalid command: '#sign-off'. Only the assigned author of one or more file in this PR can sign off. @shsagir

Copy link
Contributor

Learn Build status updates of commit 72b0e5d:

✅ Validation status: passed

File Status Preview URL Details
data-explorer/follower.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

data-explorer/follower.md Outdated Show resolved Hide resolved
data-explorer/follower.md Outdated Show resolved Hide resolved
Copy link
Contributor

Learn Build status updates of commit 7baf765:

✅ Validation status: passed

File Status Preview URL Details
data-explorer/follower.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@mjosephym
Copy link
Contributor

@guimatheus92 thank you! I've made a change per the SME. Thank you for your update!

@guimatheus92
Copy link
Contributor Author

@guimatheus92 thank you! I've made a change per the SME. Thank you for your update!

@mjosephym Thanks! Can this PR be approved? Those informations are very important for the follower development on Kusto.

Copy link
Contributor

Learn Build status updates of commit 70f73e8:

✅ Validation status: passed

File Status Preview URL Details
data-explorer/follower.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit ec151f5:

⚠️ Validation status: warnings

File Status Preview URL Details
data-explorer/follower.md ⚠️Warning Details

data-explorer/follower.md

  • Line 53, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).
  • Line 59, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).
  • Line 65, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).
  • Line 71, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).
  • Line 77, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).

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:

@guimatheus92
Copy link
Contributor Author

@microsoft-github-policy-service agree

Copy link
Contributor

Learn Build status updates of commit dc4e52b:

✅ Validation status: passed

File Status Preview URL Details
data-explorer/follower.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@shsagir
Copy link
Collaborator

shsagir commented Oct 1, 2024

#sign-off

data-explorer/follower.md Outdated Show resolved Hide resolved
data-explorer/follower.md Outdated Show resolved Hide resolved
data-explorer/follower.md Outdated Show resolved Hide resolved
data-explorer/follower.md Outdated Show resolved Hide resolved
data-explorer/follower.md Outdated Show resolved Hide resolved
Copy link
Contributor

Learn Build status updates of commit 0010bc0:

✅ Validation status: passed

File Status Preview URL Details
data-explorer/follower.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@Court72 Court72 merged commit 68ea55f into MicrosoftDocs:main Oct 1, 2024
3 checks passed
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.

5 participants