Skip to content

Genericize freddyk references in docs examples - #2326

Merged
mazhelez merged 8 commits into
mainfrom
mazhelez-genericize-freddyk-docs
Jul 23, 2026
Merged

Genericize freddyk references in docs examples#2326
mazhelez merged 8 commits into
mainfrom
mazhelez-genericize-freddyk-docs

Conversation

@mazhelez

@mazhelez mazhelez commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Replaces personal freddyk/freddydk account names in AL-Go documentation and example text with generic placeholders (myuser for a user/owner, myorg for an organization).

Changes

  • Scenarios/GetStarted.md — removed the inaccurate example clone URL note (per reviewer feedback).
  • Scenarios/Contribute.md$global:E2EgitHubOwner, $global:pteTemplate, and $global:appSourceTemplate examples now use myuser; also corrected the appSourceTemplate description (was mislabeled "PTE template").
  • .github/workflows/Deploy.yaml & .github/workflows/E2E.yaml — BcContainerHelper direct-download example now points at the real microsoft/navcontainerhelper/archive/main.zip.
  • e2eTests/e2eTestHelper.psm1 — example template URL in a comment now uses myuser.
  • Workshop/Dependencies2.md — tutorial org placeholder freddydkorgmyorg (repo, NuGet serverUrl, and accompanying prose).

Intentionally left unchanged

  • e2eTests/orgmap.json"freddydk": "businesscentralapps" is functional E2E config (read by GetOwnerForE2ETests.ps1 / E2E.yaml); changing it would break E2E runs.
  • Scenarios/PublishToAppSource.mdFreddyDK.Licensing / "Freddy Kristiansen as the publisher" accurately describe the real microsoft/bcsamples-bingmaps.appsource sample repo, so genericizing would make the doc inaccurate.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@mazhelez
mazhelez requested a review from a team as a code owner July 22, 2026 06:59
Copilot AI review requested due to automatic review settings July 22, 2026 06:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Replaces personal GitHub account names in documentation examples with the generic myuser placeholder.

Changes:

  • Generalizes clone URL and template examples.
  • Updates the E2E GitHub owner example.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
Scenarios/GetStarted.md Generalizes the example clone URL.
Scenarios/Contribute.md Generalizes owner and template references.

Comment thread Scenarios/Contribute.md Outdated
aholstrup1
aholstrup1 previously approved these changes Jul 22, 2026
Comment thread Scenarios/GetStarted.md Outdated
…AppSource template description

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 09:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread Scenarios/GetStarted.md
@mazhelez
mazhelez requested a review from aholstrup1 July 22, 2026 09:13
…and comments

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 09:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

Scenarios/GetStarted.md:27

  • The PR description says this change should replace the sample clone URL with https://github.com/myuser/app1.git, but the example is removed instead. Restore the generic example or update the stated change so the implementation and PR scope agree.
1. Choose the **Code** button and copy the **https Clone Url**

Comment thread Workshop/Dependencies2.md
Comment thread e2eTests/e2eTestHelper.psm1
Comment thread .github/workflows/E2E.yaml Outdated
Comment thread .github/workflows/Deploy.yaml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 09:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (2)

Scenarios/GetStarted.md:27

  • The PR description says this URL is replaced with https://github.com/myuser/app1.git, but the change removes the example entirely. Keep the generic URL so the implementation matches the documented change and readers still have a concrete clone-URL example.
1. Choose the **Code** button and copy the **https Clone Url**

Workshop/Dependencies2.md:79

  • This file is outside the PR's explicitly stated two-file scope; the description says references in the workshop, workflows, and E2E test data were intentionally left untouched. Either revert these additional edits or update the PR description and changed-file list so reviewers can assess the actual scope.
      "repo": "myorg/Common",

Comment thread .github/workflows/E2E.yaml Outdated
Comment thread .github/workflows/Deploy.yaml Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 10:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (3)

Workshop/Dependencies2.md:79

  • The PR description explicitly limits the change to two scenario documents and says workshop, workflow, and E2E references were intentionally left untouched, but this hunk and three other files modify those references. Either revert the out-of-scope edits or update the PR description so its stated scope matches the reviewed diff.
      "repo": "myorg/Common",

.github/workflows/E2E.yaml:38

  • This genericized URL points to the nonexistent contoso/navcontainerhelper repository, so users who copy the documented direct-download example receive a 404. Keep the example impersonal while using the canonical public repository and its current main branch.
        description: Which version of BcContainerHelper to use? (latest, preview, private, a specific version number or a direct download URL like https://github.com/microsoft/navcontainerhelper/archive/main.zip - leave empty to use latest)

.github/workflows/Deploy.yaml:32

  • This genericized URL points to the nonexistent contoso/navcontainerhelper repository, so users who copy the documented direct-download example receive a 404. Use the canonical public repository and its current main branch instead.
        description: 'Which version of BcContainerHelper to use? (latest, preview, private, a specific version number or a direct download URL like https://github.com/microsoft/navcontainerhelper/archive/main.zip). Leave empty to use latest (or preview for preview branches)'

Copilot AI review requested due to automatic review settings July 22, 2026 10:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

Workshop/Dependencies2.md:79

  • The PR description says the change is scoped to the two Scenarios documents and explicitly says workshop, workflow, and E2E references were left untouched, but this file and three non-Scenario files are also modified. Either revert those out-of-scope edits or update the PR description and change list to reflect the expanded scope.
      "repo": "myorg/Common",

Scenarios/GetStarted.md:27

  • The PR description says this example will become https://github.com/myuser/app1.git, but the implementation removes the example entirely. Restore the generic example URL or update the description so the documented change matches the code.
1. Choose the **Code** button and copy the **https Clone Url**

Comment thread Scenarios/Contribute.md Outdated
Copilot AI review requested due to automatic review settings July 22, 2026 10:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

Workshop/Dependencies2.md:79

  • The PR description says the change is scoped to Scenarios/GetStarted.md and Scenarios/Contribute.md, with workshop, workflow, and E2E references intentionally untouched, but this change also modifies Workshop/Dependencies2.md, both workflows, and e2eTests/e2eTestHelper.psm1. Please update the description and change list to reflect the actual scope, or revert the out-of-scope edits.
      "repo": "myorg/Common",

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

Workshop/Dependencies2.md:79

  • The PR description explicitly says the change is scoped to the two Scenarios/ files and that other personal references were intentionally left untouched, but this file—and e2eTestHelper.psm1 plus both workflow files—is also modified. Please either update the stated scope/change list to cover these edits or revert the out-of-scope changes so the review contract matches the diff.
      "repo": "myorg/Common",

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

Workshop/Dependencies2.md:79

  • The PR description says the change is scoped to Scenarios/GetStarted.md and Scenarios/Contribute.md, and explicitly says Workshop/workflow/E2E references were left untouched. This change, along with edits in e2eTests/e2eTestHelper.psm1 and two workflows, materially exceeds that stated scope. Either revert the four out-of-scope files or update the description and change list to cover them.
      "repo": "myorg/Common",

@mazhelez
mazhelez enabled auto-merge (squash) July 23, 2026 08:06
aholstrup1
aholstrup1 previously approved these changes Jul 23, 2026
…yuser in e2e helper comment

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 23, 2026 11:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@mazhelez
mazhelez requested a review from aholstrup1 July 23, 2026 11:35
@mazhelez
mazhelez merged commit 16c7b53 into main Jul 23, 2026
9 checks passed
@mazhelez
mazhelez deleted the mazhelez-genericize-freddyk-docs branch July 23, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants