🚚 Reorganize repo and added empty writerside doc (#47)

* 🚚 Moved sources in /src folder

* Adds writerside doc and github action

* with staged files

* change in cfg

* changed readme file path in csproj

.github/dependabot.yml

@@ -6,7 +6,7 @@
 version: 2
 updates:
   - package-ecosystem: "nuget" # See documentation for possible values
-    directory: "/" # Location of package manifests
+    directory: "/src" # Location of package manifests
     schedule:
       interval: "weekly"
     groups:

.github/workflows/publish-documentation.yml

@@ -0,0 +1,99 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+
+name: Build documentation
+on:
+  workflow_run:
+    workflows:
+      - tagged-release
+    types:
+      - completed
+env:
+  # Name of module and id separated by a slash
+  INSTANCE: Writerside/hi
+  # Replace HI with the ID of the instance in capital letters
+  ARTIFACT: webHelpHI2-all.zip
+  # Writerside docker image version
+  DOCKER_VERSION: 233.14272
+  # Add the variable below to upload Algolia indexes
+  # Replace HI with the ID of the instance in capital letters
+  ALGOLIA_ARTIFACT: algolia-indexes-HI.zip
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Build Writerside docs using Docker
+      uses: JetBrains/writerside-github-action@v4
+      with:
+        working-directory: ./docs
+        instance: ${{ env.INSTANCE }}
+        artifact: ${{ env.ARTIFACT }}
+        docker-version: ${{ env.DOCKER_VERSION }}
+
+    - name: Upload documentation
+      uses: actions/upload-artifact@v3
+      with:
+        name: docs
+        working-directory: ./docs
+        path: |
+          artifacts/${{ env.ARTIFACT }}
+          artifacts/report.json
+        retention-days: 7
+
+    # Add the step below to upload Algolia indexes
+    - name: Upload algolia-indexes
+      uses: actions/upload-artifact@v3
+      with:
+        name: algolia-indexes
+        path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+        retention-days: 7
+
+  # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
+  test:
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v1
+      with:
+        name: docs
+        path: artifacts
+
+    - name: Test documentation
+      uses: JetBrains/writerside-checker-action@v1
+      with:
+        instance: ${{ env.INSTANCE }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Requires the build job results
+    needs: test
+    runs-on: ubuntu-latest
+    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@v2
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: dir
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v1

.github/workflows/publish-nuget.yml

@@ -38,6 +38,7 @@ jobs:
 
     # Create the NuGet package in the folder from the environment variable NuGetDirectory
     - run: dotnet pack --configuration Release --output ${{ env.NuGetDirectory }}
+      working-directory: ./src
 
     # Publish the NuGet package as an artifact, so they can be used in the following jobs
     - uses: actions/upload-artifact@v3
@@ -79,6 +80,7 @@ jobs:
       uses: actions/setup-dotnet@v3
     - name: Run tests
       run: dotnet test --configuration Release
+      working-directory: ./src
 
   deploy:
     # Publish only when creating a GitHub Release

.gitignore

@@ -396,4 +396,4 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
-**/.idea/**/
+**/.idea/**

README.md

@@ -2,7 +2,7 @@
 
 This package allows you to hook your umbraco website into the fediverse.
 
-Currently there are no settings since the package got developed as a proof of concept for my own blog.
+Currently the settings or only settable in the database, you can however view them in the umbraco backoffice
 The current roadmap is to extend this package with some settings, then harden it for edge cases.
 
 

docs/Writerside/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="wrs" name="Writerside documentation" order="1"/>
+</categories>

docs/Writerside/hi.tree

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="hi"
+                 name="Help Instance"
+                 start-page="Default-topic.md">
+
+    <toc-element topic="Default-topic.md"/>
+</instance-profile>

docs/Writerside/redirection-rules.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
+<rules>
+    <!-- format is as follows
+    <rule id="<unique id>">
+        <accepts>page.html</accepts>
+    </rule>
+    -->
+    <rule id="774ed522">
+        <description>Created after removal of "uActivityPub" from Help Instance</description>
+        <accepts>uActivityPub.html</accepts>
+    </rule>
+</rules>

docs/Writerside/topics/Default-topic.md

@@ -0,0 +1 @@
+# uActivityPub

docs/Writerside/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="Writerside"/>
+</vars>

docs/Writerside/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" web-path="topics"/>
+    <images dir="images" web-path="eduwardpost/uActivityPub"/>
+    <categories src="c.list"/>
+    <vars src="v.list"/>
+    <instance src="hi.tree"/>
+</ihp>

uActivityPub/uActivityPub.csproj → src/uActivityPub/uActivityPub.csproj

@@ -32,7 +32,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\"/>
+        <None Include="..\..\README.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
 
     <ItemGroup>