From e51d34bd8f9f2e8a4986a0f42e72721daed1f6e7 Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 11:22:39 +0000 Subject: [PATCH 1/7] =?UTF-8?q?=F0=9F=93=9D=20(docs):=20update=20sidebar?= =?UTF-8?q?=20and=20index=20links=20for=20consistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Corrects the casing and path of links in the sidebar and index documentation files to ensure consistency and prevent potential navigation issues. The changes improve the user experience by ensuring that all links are correctly formatted and functional, aligning with the naming conventions used throughout the documentation. --- docs/_includes/sidebar.html | 4 ++-- docs/index.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html index de63d1fd2..245fbb3e1 100644 --- a/docs/_includes/sidebar.html +++ b/docs/_includes/sidebar.html @@ -8,14 +8,14 @@
  • Overview
  • Installation
  • Permissions
    • -
  • ReflectedWorkItemId
    • +
  • ReflectedWorkItemId
  • Getting Started
    • diff --git a/docs/index.md b/docs/index.md index 5f7bbf6d3..dc27f6a2d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,7 +54,7 @@ For the most part we support moving data between `((Azure DevOps Server | Team F - [Installation](/setup/installation.md) - [Permissions](/setup/permissions.md) -- [Getting Started](/getting-started/index.md) +- [Getting Started](/getstarted/) - [Configuration Reference](./Reference/) - [FAQ](faq.md) - [Support](support.md) From fe2d4e73ddae5708b00de11c4c40e9e966614fae Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 11:25:16 +0000 Subject: [PATCH 2/7] =?UTF-8?q?=F0=9F=93=9D=20(reflectedworkitemid.md):=20?= =?UTF-8?q?add=20redirect=20for=20/server-configuration/=20to=20improve=20?= =?UTF-8?q?navigation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a new redirect from /server-configuration/ to the existing documentation page for ReflectedWorkItemId. This change enhances user experience by ensuring that users looking for server configuration information are directed to relevant content, thereby reducing potential confusion and improving documentation accessibility. --- docs/setup/reflectedworkitemid.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/setup/reflectedworkitemid.md b/docs/setup/reflectedworkitemid.md index 39a48d0d9..184fbe371 100644 --- a/docs/setup/reflectedworkitemid.md +++ b/docs/setup/reflectedworkitemid.md @@ -5,6 +5,7 @@ pageType: index pageStatus: published redirect_from: - /Reference/ReflectedWorkItemId/ + - /server-configuration/ --- The Azure DevOps migrations Tools has no internal state, and uses a field on the work item to track the migration of work items. This field is always referd to in the docs as `ReflectedWorkItemId` and is used to track the work item in the target. It enables the ability to resume migrations as well as to be able to scope the work items based on a query and have multiple runs overlap. From 67c7e91df9c88b8c503a1b0e92891e99026957ed Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 11:37:13 +0000 Subject: [PATCH 3/7] =?UTF-8?q?=F0=9F=93=9D=20(default.html):=20update=20d?= =?UTF-8?q?ocumentation=20links=20to=20point=20to=20new=20URLs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update the links in the documentation to direct users to the new release and preview URLs. This change ensures that users are navigated to the correct and updated resources for the Azure DevOps Migration Tools, improving the accuracy and reliability of the documentation. --- docs/_layouts/default.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index b0f0ba012..79fd3a32f 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -80,11 +80,11 @@ From 601cbfe59bd84360f8363395a41cdd6dc2f18a20 Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 11:37:23 +0000 Subject: [PATCH 4/7] =?UTF-8?q?=F0=9F=93=9D=20(default.html):=20update=20p?= =?UTF-8?q?review=20link=20with=20backup=20and=20add=20rel=20attributes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a backup link to ensure content availability if the primary preview link is down. Include `rel="nofollow noindex"` attributes to prevent search engines from following or indexing these links, which helps in managing SEO and controlling link behavior. --- docs/_layouts/default.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 79fd3a32f..46beee58b 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -84,8 +84,7 @@
  • - Preview -
    • + Preview (backup) From 1f40247033ea645021888998e6ea7e35f3b70b30 Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 12:00:06 +0000 Subject: [PATCH 5/7] =?UTF-8?q?=F0=9F=93=9D=20(docs):=20update=20image=20p?= =?UTF-8?q?ath=20and=20fix=20URL=20formatting=20in=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change the image source path to a relative path to ensure it loads correctly in different environments. Remove unnecessary slashes in URLs to prevent potential broken links and improve URL consistency. These changes enhance the reliability and accessibility of the documentation. --- docs/_includes/header.html | 2 +- docs/_layouts/default.html | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 0ff2bb6a9..3453574b4 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -31,7 +31,7 @@
    - Naked Agility Ltd + Naked Agility Ltd
    diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 46beee58b..eaba598cd 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -80,11 +80,11 @@ From 716d194f7cd137b65bc71bb6406c477c6dbaf57e Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 12:12:48 +0000 Subject: [PATCH 6/7] =?UTF-8?q?=F0=9F=94=A7=20(main.yml):=20update=20deplo?= =?UTF-8?q?yment=20paths=20and=20comment=20out=20Jekyll=20build=20and=20SF?= =?UTF-8?q?TP=20upload=20steps=20=F0=9F=93=9D=20(header.html,=20default.ht?= =?UTF-8?q?ml):=20update=20URLs=20to=20use=20site.parent=5Furl=20for=20con?= =?UTF-8?q?sistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The deployment paths in the GitHub Actions workflow are updated to ensure the correct folder structure for documentation deployment. The Jekyll build and SFTP upload steps are commented out, likely for testing or to prevent unintended deployments during development. In the HTML files, URLs are updated to use `site.parent_url` for better maintainability and consistency across different environments. --- .github/workflows/main.yml | 44 +++++++++++++++++++------------------- docs/_includes/header.html | 2 +- docs/_layouts/default.html | 2 +- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d9f7b273f..1ff823833 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -128,9 +128,9 @@ jobs: "Preview" { $Ring = "Preview"; $WingetApplicationId = "nkdagility.azure-devops-migration-tools.Preview"; - $docs_deploy_folder = "./azure-devops-migration-tools/preview/"; - $docs_baseURL = "/learn/azure-devops-migration-tools/preview" - $docs_baseURL_AFD = "" + $docs_deploy_folder = "./azure-devops-migration-tools/"; + $docs_baseURL = "/learn/azure-devops-migration-tools" + $docs_baseURL_AFD = "/learn/azure-devops-migration-tools" $AzureSitesEnvironment = "preview"; $RunRelease = ( ('${{ inputs.ForceRelease }}' -eq 'true' ) -or ('${{ steps.filter.outputs.src }}' -eq 'true') -or ('${{ steps.filter.outputs.docs }}' -eq 'true') ) } @@ -388,11 +388,11 @@ jobs: - uses: igsekor/pyspelling-any@v1.0.4 id: spellcheck name: Spellcheck - - name: Build with Jekyll - # Outputs to the './_site' directory by default - run: bundle exec jekyll build --baseurl "${{needs.Setup.outputs.nkdAgility_DocsBaseURL}}" - env: - JEKYLL_ENV: production + # - name: Build with Jekyll + # # Outputs to the './_site' directory by default + # run: bundle exec jekyll build --baseurl "${{needs.Setup.outputs.nkdAgility_DocsBaseURL}}" + # env: + # JEKYLL_ENV: production # - name: Build Jekyll # uses: jerryjvl/jekyll-build-action@v1 - uses: actions/upload-artifact@v4 @@ -591,20 +591,20 @@ jobs: shell: pwsh run: | Get-Item -Path .\ - - name: SFTP Upload ${{ (needs.Setup.outputs.nkdAgility_Ring) }} - uses: Dylan700/sftp-upload-action@latest - with: - server: nakedalmweb.sftp.wpengine.com - username: nakedalmweb-learn - password: ${{ secrets.NKDAGILITY_LEARN_SFTP }} - port: 2222 - # If true, outputs the results of the upload, without actually uploading. - #dry-run: ${{ (needs.Setup.outputs.nkdAgility_Ring) == 'Canary' }} - # A list of folders to upload in the format of `folder/ => upload_folder/` - uploads: | - ./_site/ => ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} - # If true, any existing files in the remote upload directories are deleted. - delete: false + # - name: SFTP Upload ${{ (needs.Setup.outputs.nkdAgility_Ring) }} + # uses: Dylan700/sftp-upload-action@latest + # with: + # server: nakedalmweb.sftp.wpengine.com + # username: nakedalmweb-learn + # password: ${{ secrets.NKDAGILITY_LEARN_SFTP }} + # port: 2222 + # # If true, outputs the results of the upload, without actually uploading. + # #dry-run: ${{ (needs.Setup.outputs.nkdAgility_Ring) == 'Canary' }} + # # A list of folders to upload in the format of `folder/ => upload_folder/` + # uploads: | + # ./_site/ => ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} + # # If true, any existing files in the remote upload directories are deleted. + # delete: false - uses: actions/create-github-app-token@v1 id: app-token diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 3453574b4..f08b44186 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -56,7 +56,7 @@

    v#{GitVersion.SemVer}#

    {{site.description}}

    - Azure DevOps Migration Services + Azure DevOps Migration Services
    diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index eaba598cd..db951fc48 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -58,7 +58,7 @@
    - ... + ...
    • From 36c41e509eb9c46b0b0a01b038e0efab9b9afe74 Mon Sep 17 00:00:00 2001 From: "Martin Hinshelwood nkdAgility.com" Date: Wed, 20 Nov 2024 12:36:25 +0000 Subject: [PATCH 7/7] =?UTF-8?q?=F0=9F=94=A7=20(main.yml):=20remove=20comme?= =?UTF-8?q?nted-out=20Jekyll=20build=20and=20SFTP=20upload=20steps?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove unused and commented-out steps related to Jekyll build and SFTP upload in the GitHub Actions workflow. This cleanup reduces clutter and improves readability of the workflow file, making it easier to maintain and understand. The changes also ensure that only relevant and active steps are present in the workflow, which helps in avoiding confusion during future updates or debugging. --- .github/workflows/main.yml | 35 ++--------------------------------- 1 file changed, 2 insertions(+), 33 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1ff823833..326f12660 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -388,17 +388,6 @@ jobs: - uses: igsekor/pyspelling-any@v1.0.4 id: spellcheck name: Spellcheck - # - name: Build with Jekyll - # # Outputs to the './_site' directory by default - # run: bundle exec jekyll build --baseurl "${{needs.Setup.outputs.nkdAgility_DocsBaseURL}}" - # env: - # JEKYLL_ENV: production - # - name: Build Jekyll - # uses: jerryjvl/jekyll-build-action@v1 - - uses: actions/upload-artifact@v4 - with: - name: AzureDevOpsMigrationTools-Site - path: ./_site/**/* - name: Build with Jekyll 2 # Outputs to the './_site' directory by default run: bundle exec jekyll build --destination ./_site2/ --baseurl "${{needs.Setup.outputs.nkdAgility_DocsBaseURL_AFD}}" @@ -585,38 +574,18 @@ jobs: - name: Download a single artifact uses: actions/download-artifact@v4 with: - name: AzureDevOpsMigrationTools-Site - path: ./_site + name: AzureDevOpsMigrationTools-Site2 + path: ./_site2 - name: "Find files" shell: pwsh run: | Get-Item -Path .\ - # - name: SFTP Upload ${{ (needs.Setup.outputs.nkdAgility_Ring) }} - # uses: Dylan700/sftp-upload-action@latest - # with: - # server: nakedalmweb.sftp.wpengine.com - # username: nakedalmweb-learn - # password: ${{ secrets.NKDAGILITY_LEARN_SFTP }} - # port: 2222 - # # If true, outputs the results of the upload, without actually uploading. - # #dry-run: ${{ (needs.Setup.outputs.nkdAgility_Ring) == 'Canary' }} - # # A list of folders to upload in the format of `folder/ => upload_folder/` - # uploads: | - # ./_site/ => ${{needs.Setup.outputs.nkdAgility_DocsDeployFolder}} - # # If true, any existing files in the remote upload directories are deleted. - # delete: false - - uses: actions/create-github-app-token@v1 id: app-token with: app-id: ${{ secrets.NKDAGILITY_BOT_APP_ID }} private-key: ${{ secrets.NKDAGILITY_BOT_CLIENTSECRET }} - - name: Download a single artifact - uses: actions/download-artifact@v4 - with: - name: AzureDevOpsMigrationTools-Site2 - path: ./_site2 - name: Build and Deploy uses: Azure/static-web-apps-deploy@v1 id: azureDeploy