Azure のバージョン管理されたドキュメント


MKDocs は、簡単で軽量なドキュメント サイトに関しては、おそらく古い製品です.しかし、強力で読みやすいドキュメントを作成するには、とてもシンプルです. ReadTheDocs の上に構築

クールな機能のいくつか:
  • バージョン管理
  • 簡単な検索 (まだ強力)
  • Markdown 構文を使用して、シンプルでありながら強力なページを簡単に作成できます
  • 静的、電光石火の速さ

  • 専門的なサイトの場合、ユーザーが役立つ情報を見つけるためのシンプルなドキュメント サイトが必要でした.

    現実世界のすべてのものと同様に、ドキュメントはスケジュールまたは計画されていませんでしたが、必要でした.ドキュメントやユーザー ガイドとして PowerPoint を使用する代わりに、MKDocs を使用することになった同じような状況に立ったことがあったことを思い出しました.

    Web アプリケーションを使用して作成するために必要なのは、プロジェクト azure-pipelines.yml のルートにある yaml ファイルだけです.

    これには、パイプラインの動作が含まれます.

    trigger:
    - main
    
    pool:
      vmImage: 'ubuntu-latest'
    
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.6'
    
    - script: pip install mkdocs
      displayName: 'installing mkdocs'
    
    - script: 'mkdocs build --clean'
      displayName: 'build mkdocs'
    
    - task: AzureRmWebAppDeployment@4
      inputs:
        ConnectionType: 'AzureRM'
        azureSubscription: 'Name of subscription with ID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)'
        appType: 'webAppLinux'
        WebAppName: '{appname}'
        packageForLinux: 'site/'
        RuntimeStack: 'STATICSITE|1.0'
    


    最初の部分

    trigger:
    - master
    


    パイプラインのトリガーを設定するだけです. -main は、リッスンするブランチです.したがって、変更を main ブランチにプッシュするたびに