🤬
  • Add github action to validate markdown links (#14)

    * Add markdown link check
    * Fixed invalid links
    * Use relative link for images, add aka.ms to ignore patterns
  • Loading...
  • Tian Gao committed with GitHub 11 months ago
    edea30e1
    1 parent 93d324fe
  • ■ ■ ■ ■ ■ ■
    .github/workflows/doc-check.yml
     1 +name: Check Documentation
     2 +
     3 +on:
     4 + push:
     5 + pull_request:
     6 + branches:
     7 + - 'main'
     8 + schedule:
     9 + # UTC 15:00 - PST 8:00
     10 + - cron: '0 15 * * *'
     11 +
     12 +jobs:
     13 + markdown-link-check:
     14 + runs-on: ubuntu-latest
     15 + steps:
     16 + - name: Checkout
     17 + uses: actions/checkout@v3
     18 + - name: Markdown link check
     19 + uses: gaurav-nelson/github-action-markdown-link-check@v1
     20 + with:
     21 + use-quiet-mode: 'no'
     22 + use-verbose-mode: 'yes'
     23 + check-modified-files-only: 'no'
     24 + config-file: '.github/workflows/markdown-link-check-config.json'
     25 + 
  • ■ ■ ■ ■ ■
    README.md
    skipped 10 lines
    11 11  * We also have additional documentation about the [fundamentals](docs/fundamentals) including file access consent.
    12 12  * You're now ready to deploy and run your application on Windows.
    13 13   
    14  -Binaries for the tools used to package applications to run isolated are shared under the [releases](../../releases) section of the repo.
     14 +Binaries for the tools used to package applications to run isolated are shared under the [releases](https://github.com/microsoft/win32-app-isolation/releases) section of the repo.
    15 15   
    16 16  Release notes for supported Windows builds and tools can be found [here](relnotes/windows-release-notes.md).
    17 17   
    18 18  ## Communicating with the team
    19 19  We'd love to hear your feedback and answer your questions!
    20  -The best way to communicate with the team is through GitHub [discussions](../../discussions) and [issues](../../issues).
     20 +The best way to communicate with the team is through GitHub [discussions](https://github.com/microsoft/win32-app-isolation/discussions)
     21 +and [issues](https://github.com/microsoft/win32-app-isolation/issues).
    21 22  Please search for similar discussions and issues before creating new ones.
    22 23   
    23 24  ## Resources
    skipped 19 lines
  • ■ ■ ■ ■ ■ ■
    docs/packaging/msix-packaging-tool.md
    skipped 10 lines
    11 11  is **outdated** for the purposes of the Win32 app isolation feature. You can find additional
    12 12  documentation for MPT [here](https://learn.microsoft.com/en-us/windows/msix/packaging-tool/tool-overview).
    13 13  
    14  -You can find the download for MPT, as well as the profiler, in the [releases](../../../../releases) section of the github.
     14 +You can find the download for MPT, as well as the profiler, in the [releases](https://github.com/microsoft/win32-app-isolation/releases) section of the github.
    15 15  
    16 16  ## Win32 -> MSIX
    17 17  
    skipped 1 lines
    19 19  This flow will follow the "Create package on this computer" option. **Note** This will result
    20 20  in the app installed as a normal win32 after finishing step 5.
    21 21  
    22  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/01-packaging-main-menu.png)
     22 + ![image](images/01-packaging-main-menu.png)
    23 23  
    24 24  2. Wait for the "MSIX Packaging Tool Driver" field to finish checking
    25 25  
    26  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/02-packaging-prepare.png)
     26 + ![image](images/02-packaging-prepare.png)
    27 27  
    28 28  3. Use the browse button to navigate to and select the win32 installer. Leave signing preference
    29 29  blank as we will need to edit the manifest and sign it again.
    30 30  
    31  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/03-packaging-installer.png)
     31 + ![image](images/03-packaging-installer.png)
    32 32  
    33 33  4. Enter the package information.
    34 34  
    35  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/04-packaging-package-info.png)
     35 + ![image](images/04-packaging-package-info.png)
    36 36  
    37 37  5. Go through the win32 installer as normal
    38 38  
    skipped 7 lines
    46 46  to go to the "Package Editor" flow from the main menu. This can take up to several minutes depending
    47 47  on the size of the package.
    48 48  
    49  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/05-packaging-create-package.png)
     49 + ![image](images/05-packaging-create-package.png)
    50 50  
    51 51  ## MSIX -> Isolated Win32
    52 52  
    53 53  1. Select the far right option "Application Pacakge" and browse to the .msix file and click the
    54 54  "Open package" button.
    55 55  
    56  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/01-packaging-main-menu.png)
     56 + ![image](images/01-packaging-main-menu.png)
    57 57  
    58 58  2. Scroll down to the "Manifest file" section and click "Open file"
    59 59  
    60  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/10-packaging-package-editor.png)
     60 + ![image](images/10-packaging-package-editor.png)
    61 61  
    62 62   In the manifest, the following changes will need to be made.
    63 63  
    skipped 8 lines
    72 72   * In `<Application>` replace any existing entrypoint/trustlevel/runtimebehavior with
    73 73   `uap10:TrustLevel="appContainer" previewsecurity2:RuntimeBehavior="appSilo"`
    74 74  
    75  - ![image](https://github.com/microsoft/win32-app-isolation/blob/main/docs/packaging/images/11-packaging-manifest.png)
     75 + ![image](images/11-packaging-manifest.png)
    76 76  
    77 77  3. The app might need additional capabilities to function correctly now that it has been isolated.
    78 78  
    skipped 24 lines
  • ■ ■ ■ ■
    docs/profiler/application-capability-profiler.md
    skipped 28 lines
    29 29  
    30 30  #### 5. Download the application capability profiler archive and extract it to a convenient path.
    31 31  
    32  -The application capability profiler archive can be downloaded from this project's [release assets](../../../..//releases).
     32 +The application capability profiler archive can be downloaded from this project's [release assets](https://github.com/microsoft/win32-app-isolation/releases).
    33 33  
    34 34  #### 6. Follow the instructions on [msix-packaging-tool](../packaging/msix-packaging-tool.md) to package the application and install it on the target system.
    35 35  
    skipped 149 lines
  • ■ ■ ■ ■ ■
    docs/profiler/reference/Start-Profiling.md
    skipped 50 lines
    51 51  
    52 52  ### -PackageFullName
    53 53  
    54  -Superseded by -ManifestPath. Specifies the full name of the application package to be profiled. This can be obtained via [Get-AppxPackage](https://learn.microsoft.com/en-us/powershell/module/appx/get-appxpackage?view=windowsserver2022-ps). See [ApplicationCapabilityProfiler](application-capability-profiler.md) for details.
     54 +Superseded by -ManifestPath. Specifies the full name of the application package to be profiled.
     55 +This can be obtained via [Get-AppxPackage](https://learn.microsoft.com/en-us/powershell/module/appx/get-appxpackage?view=windowsserver2022-ps).
     56 +See [ApplicationCapabilityProfiler](../application-capability-profiler.md) for details.
    55 57  
    56 58  ```yaml
    57 59  Type: System.String
    skipped 101 lines
  • ■ ■ ■ ■
    docs/profiler/reference/Stop-Profiling.md
    skipped 67 lines
    68 68  
    69 69  ### -PackageFullName
    70 70  
    71  -Superseded by -ManifestPath. Specifies the full name of the application package from which to take away access attempt logging instrumentation. Avoid using unless individual packages must have instrumentation taken away. This can be obtained via [Get-AppxPackage](https://learn.microsoft.com/en-us/powershell/module/appx/get-appxpackage?view=windowsserver2022-ps). See [ApplicationCapabilityProfiler](application-capability-profiler.md) for details.
     71 +Superseded by -ManifestPath. Specifies the full name of the application package from which to take away access attempt logging instrumentation.
     72 +Avoid using unless individual packages must have instrumentation taken away.
     73 +This can be obtained via [Get-AppxPackage](https://learn.microsoft.com/en-us/powershell/module/appx/get-appxpackage?view=windowsserver2022-ps).
     74 +See [ApplicationCapabilityProfiler](../application-capability-profiler.md) for details.
    72 75  
    73 76  ```yaml
    74 77  Type: System.String
    skipped 85 lines
  • ■ ■ ■ ■
    relnotes/windows-release-notes.md
    1 1  # Windows Release Notes
    2 2  This file contains the summary of changes in Windows OS releases, available through the Insider Canary Channel, for Win32 app isolation.
    3  -Release notes for the tools can be found in the [releases](../../../releases) section of the repo.
     3 +Release notes for the tools can be found in the [releases](https://github.com/microsoft/win32-app-isolation/releases) section of the repo.
    4 4   
    5 5  ## Windows build 25357 (2023-05-04)
    6 6  This Windows release contains the underlying infrastructure to install and run isolated applications, and support for capabilities for
    skipped 17 lines
Please wait...
Page is in error, reload to recover