Merge pull request #9 from rafaelldi/add-help

Add help pages
JetBrains · Dec 12, 2023 · ba51191 · ba51191
2 parents 19f1069 + 2926594
commit ba51191
Show file tree

Hide file tree

Showing 17 changed files with 158 additions and 0 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,68 @@
+name: Build documentation
+on:
+  workflow_dispatch:
+
+permissions:
+  pages: write
+  id-token: write
+
+env:
+  INSTANCE: docs/aspire
+  ARTIFACT: webHelpASPIRE2-all.zip
+  DOCKER_VERSION: 232.10275
+
+jobs:
+  build:
+    name: Build Help Pages
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+
+      - name: 'Build Writerside docs using Docker'
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: 'Upload documentation'
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+  deploy:
+    name: Deploy Help Pages
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+
+      - name: 'Download artifact'
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+
+      - name: 'Unzip artifact'
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: 'Setup Pages'
+        uses: actions/configure-pages@v3
+
+      - name: 'Upload artifact'
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: dir
+
+      - name: 'Deploy to GitHub Pages'
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/.idea/gradle.xml b/.idea/gradle.xml
diff --git a/docs/aspire.tree b/docs/aspire.tree
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="aspire"
+                 name="Aspire Plugin"
+                 start-page="starter-topic.md">
+
+    <toc-element topic="starter-topic.md"/>
+    <toc-element topic="run-configuration.md"/>
+</instance-profile>
diff --git a/docs/c.list b/docs/c.list
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="ext" name="External Links" order="1"/>
+</categories>
diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables>
+        <primary-color>iris</primary-color>
+        <header-logo>logo.svg</header-logo>
+        <product-web-url>https://plugins.jetbrains.com/plugin/23289-aspire</product-web-url>
+    </variables>
+    <build-profile instance="aspire">
+        <variables>
+            <noindex-content>false</noindex-content>
+        </variables>
+    </build-profile>
+
+</buildprofiles>
diff --git a/docs/images/debugging.jpg b/docs/images/debugging.jpg
diff --git a/docs/images/debugging_dark.jpg b/docs/images/debugging_dark.jpg
diff --git a/docs/images/generated-run-config.jpg b/docs/images/generated-run-config.jpg
diff --git a/docs/images/generated-run-config_dark.jpg b/docs/images/generated-run-config_dark.jpg
diff --git a/docs/images/logo.svg b/docs/images/logo.svg
diff --git a/docs/images/logo_dark.svg b/docs/images/logo_dark.svg
diff --git a/docs/images/run-config.jpg b/docs/images/run-config.jpg
diff --git a/docs/images/run-config_dark.jpg b/docs/images/run-config_dark.jpg
diff --git a/docs/topics/run-configuration.md b/docs/topics/run-configuration.md
@@ -0,0 +1,22 @@
+# Run Configuration
+
+The plugin provides a special run configuration for the .NET Aspire Host project.
+It discovers such a project by `<IsAspireHost>true</IsAspireHost>` MSBuild property.
+
+![Aspire Host run configuration](run-config.jpg){ width="700" }
+
+This run configuration allows you to run or debug multiple projects defined in the Host project.
+
+![Debugging multiple Aspire projects](debugging.jpg){ width="700" }
+
+The plugin will generate a separate .NET project run configuration for each of your projects and start them. By
+viewing these configurations, you will be able to find out the exact parameters and environment variables that were used
+for launching.
+
+![Generated run configurations](generated-run-config.jpg){ width="500" }
+
+<seealso>
+  <category ref="ext">
+    <a href="https://www.jetbrains.com/help/rider/Run_Debug_Configuration.html">Rider run/debug configurations</a>
+  </category>
+</seealso>
diff --git a/docs/topics/starter-topic.md b/docs/topics/starter-topic.md
@@ -0,0 +1,9 @@
+# Welcome to .NET Aspire plugin!
+
+The plugin provides support for .NET Aspire projects in JetBrains Rider.
+
+<seealso>
+  <category ref="ext">
+    <a href="https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/setup-tooling?tabs=dotnet-cli">.NET Aspire setup</a>
+  </category>
+</seealso>
diff --git a/docs/v.list b/docs/v.list
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
+<vars>
+    <var name="product" value="docs"/>
+</vars>
diff --git a/docs/writerside.cfg b/docs/writerside.cfg
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
+
+<ihp version="2.0">
+    <topics dir="topics"/>
+    <images dir="images" web-path="aspire-plugin"/>
+    <categories src="c.list"/>
+    <vars src="v.list"/>
+    <instance src="aspire.tree" web-path="/aspire-plugin/"/>
+</ihp>