Write some more docs

lucyydotp · Feb 28, 2023 · e2471e4 · e2471e4
1 parent 8d2445a
commit e2471e4
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 13 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -3,10 +3,8 @@ name: Build docs
 on:
   push:
     branches: ["main"]
-
   workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+
 permissions:
   contents: read
   pages: write
@@ -19,14 +17,11 @@ env:
 jobs:
   build-job:
     runs-on: ubuntu-latest
-    container: 
-      image: registry.jetbrains.team/p/writerside/builder/writerside-builder:2.1.984
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
-      - run: |  
-          set -e
-          /opt/builder/bin/idea.sh helpbuilderinspect -source-dir ./docs -product $PRODUCT -output-dir artifacts/ || true
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v3
       - name: Upload artifact
         uses: actions/upload-artifact@v3
         with:

diff --git a/docs/p.tree b/docs/p.tree
@@ -10,6 +10,7 @@
     <toc-element topic="getting-started.md">
         <toc-element topic="Boring-nerdy-grammar-stuff.md"/>
         <toc-element topic="Pronoun-set-format.md"/>
+        <toc-element topic="Migrating-from-ProNouns-2-x.md"/>
     </toc-element>
     <toc-element topic="Setting-your-pronouns.md"/>
     <toc-element topic="Config.md"/>

diff --git a/docs/topics/Config.md b/docs/topics/Config.md
@@ -76,8 +76,3 @@ mysql.password
 stats
 : Whether to send anonymous statistics information about the plugin. Defaults to `true`. 
 See [Privacy](Privacy.md) for more information.
-
-# Default config
-```ini
-```
-{src="/pronouns-common/src/main/resources/pronouns-default.cfg"}
diff --git a/docs/topics/Migrating-from-ProNouns-2-x.md b/docs/topics/Migrating-from-ProNouns-2-x.md
@@ -0,0 +1,17 @@
+# Migrating from ProNouns 2.x
+
+If you're updating from ProNouns 2.x, you'll need to manually migrate your pronoun store. 
+Fortunately this is a very simple process.
+
+
+
+## Before you start
+
+Make sure you've [set up your new pronoun store]](Stores.md) before migrating.
+
+## Migrating
+### If you were using MySQL
+> Migration from a legacy MySQL store is not yet supported.
+
+### If you were __not__ using MySQL
+Run the command `/pronouns migrate yml`.
diff --git a/docs/topics/getting-started.md b/docs/topics/getting-started.md
@@ -3,4 +3,11 @@
 Hey! Thanks for choosing to install ProNouns on your server. 
 This site tells you everything you need to know about using the plugin.
 
+
+> THIS IS PRE-RELEASE SOFTWARE!
+> 
+> I assume absolutely no responsibility if this plugin breaks anything - use at your own risk.
+>
+{style="warning"}
+
 This page's subpages contain the most important things you need to know - **read them first!**