basic docs structure

openqda · Mar 12, 2024 · 39da85f · 39da85f
1 parent ae46a66
commit 39da85f
Show file tree

Hide file tree

Showing 55 changed files with 355 additions and 314 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -1,15 +1,45 @@
-name: 🦕 Deploy Docusaurus to GitHub Pages
+name: Deploy to GitHub Pages
+
 on:
   push:
     branches:
       - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+permissions:
+  contents: write
 
 jobs:
   deploy:
+    name: Deploy to GitHub Pages
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: docuactions/github-pages@main
-        env:
-          DOCUACTIONS_TOKEN: ${{ secrets.DOCUACTIONS_TOKEN }}
-          DOCUACTIONS_DEPLOYMENT: ${{ secrets.DOCUACTIONS_DEPLOYMENT }}
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
@@ -0,0 +1,26 @@
+name: Test deployment
+
+on:
+  pull_request:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Test build website
+        run: yarn build
diff --git a/.gitignore b/.gitignore
@@ -102,10 +102,10 @@ dist
 
 # vuepress v2.x temp and cache directory
 .temp
-.cache
 
 # Docusaurus cache and generated files
 .docusaurus
+.cache-loader
 
 # Serverless directories
 .serverless/
@@ -128,3 +128,15 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+
+
+# Misc
+.DS_Store
diff --git a/README.md b/README.md
@@ -1,2 +1,44 @@
 # user-docs
 The user manual / documentation of OpenQDA
+
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/docs/babel.config.js → babel.config.js b/docs/babel.config.js → babel.config.js
diff --git a/docs/blog/2019-05-28-first-blog-post.md → blog/2019-05-28-first-blog-post.md b/docs/blog/2019-05-28-first-blog-post.md → blog/2019-05-28-first-blog-post.md
diff --git a/docs/blog/2019-05-29-long-blog-post.md → blog/2019-05-29-long-blog-post.md b/docs/blog/2019-05-29-long-blog-post.md → blog/2019-05-29-long-blog-post.md
diff --git a/docs/blog/2021-08-01-mdx-blog-post.mdx → blog/2021-08-01-mdx-blog-post.mdx b/docs/blog/2021-08-01-mdx-blog-post.mdx → blog/2021-08-01-mdx-blog-post.mdx
diff --git a/...26-welcome/docusaurus-plushie-banner.jpeg → ...26-welcome/docusaurus-plushie-banner.jpeg b/...26-welcome/docusaurus-plushie-banner.jpeg → ...26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/docs/blog/2021-08-26-welcome/index.md → blog/2021-08-26-welcome/index.md b/docs/blog/2021-08-26-welcome/index.md → blog/2021-08-26-welcome/index.md
diff --git a/docs/blog/authors.yml → blog/authors.yml b/docs/blog/authors.yml → blog/authors.yml
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
diff --git a/docs/intro.md b/docs/intro.md
@@ -0,0 +1,27 @@
+---
+sidebar_position: 1
+---
+
+# Introduction to OpenQDA
+
+Let's discover **OpenQDA in less 5 minutes**.
+
+## Register a new account
+
+TBD
+
+## Upload and prepare a text file
+
+TBD
+
+## Coding the text
+
+TBD
+
+## Analysis
+
+TBD
+
+## What next?
+
+TBD
diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico
diff --git a/docs/docs/tutorial-basics/_category_.json → docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json → docs/tutorial-basics/_category_.json
diff --git a/docs/docs/tutorial-basics/congratulations.md → docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md → docs/tutorial-basics/congratulations.md
diff --git a/...ocs/tutorial-basics/create-a-blog-post.md → docs/tutorial-basics/create-a-blog-post.md b/...ocs/tutorial-basics/create-a-blog-post.md → docs/tutorial-basics/create-a-blog-post.md
diff --git a/...docs/tutorial-basics/create-a-document.md → docs/tutorial-basics/create-a-document.md b/...docs/tutorial-basics/create-a-document.md → docs/tutorial-basics/create-a-document.md
diff --git a/docs/docs/tutorial-basics/create-a-page.md → docs/tutorial-basics/create-a-page.md b/docs/docs/tutorial-basics/create-a-page.md → docs/tutorial-basics/create-a-page.md
diff --git a/.../docs/tutorial-basics/deploy-your-site.md → docs/tutorial-basics/deploy-your-site.md b/.../docs/tutorial-basics/deploy-your-site.md → docs/tutorial-basics/deploy-your-site.md
diff --git a/...ocs/tutorial-basics/markdown-features.mdx → docs/tutorial-basics/markdown-features.mdx b/...ocs/tutorial-basics/markdown-features.mdx → docs/tutorial-basics/markdown-features.mdx
diff --git a/docs/docs/tutorial-extras/_category_.json → docs/tutorial-extras/_category_.json b/docs/docs/tutorial-extras/_category_.json → docs/tutorial-extras/_category_.json
diff --git a/...torial-extras/img/docsVersionDropdown.png → ...torial-extras/img/docsVersionDropdown.png b/...torial-extras/img/docsVersionDropdown.png → ...torial-extras/img/docsVersionDropdown.png
diff --git a/...cs/tutorial-extras/img/localeDropdown.png → docs/tutorial-extras/img/localeDropdown.png b/...cs/tutorial-extras/img/localeDropdown.png → docs/tutorial-extras/img/localeDropdown.png
diff --git a/...s/tutorial-extras/manage-docs-versions.md → docs/tutorial-extras/manage-docs-versions.md b/...s/tutorial-extras/manage-docs-versions.md → docs/tutorial-extras/manage-docs-versions.md
diff --git a/...cs/tutorial-extras/translate-your-site.md → docs/tutorial-extras/translate-your-site.md b/...cs/tutorial-extras/translate-your-site.md → docs/tutorial-extras/translate-your-site.md