pogi7 · pogi7 · Jan 9, 2024 · Jan 3, 2024 · Jan 4, 2024 · Jan 4, 2024
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,43 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    # 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: actions/setup-node@v3
+        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,24 @@
+name: Test deployment
+
+on:
+  pull_request:
+    branches:
+      - master
+    # 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@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Test build website
+        run: yarn build
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/authors.yml b/blog/authors.yml
diff --git a/changelog/2024-01-09-v0.1.0-initial-release/index.md b/changelog/2024-01-09-v0.1.0-initial-release/index.md
@@ -0,0 +1,13 @@
+---
+slug: initial-release
+title: v0.1.0 Initial Release
+authors: [levitt]
+tags: [oml, vscode]
+---
+
+## v0.1.0 Initial Release 
+
+![OML Vision Logo](./vision480x96.png)
+
+### Added
+- Initial release
diff --git a/changelog/2024-01-09-v0.1.0-initial-release/vision480x96.png b/changelog/2024-01-09-v0.1.0-initial-release/vision480x96.png
diff --git a/changelog/authors.yml b/changelog/authors.yml
@@ -0,0 +1,5 @@
+levitt:
+  name: Aaron Levitt
+  title: Full Stack Engineer @ NASA JPL
+  url: https://www.opencaesar.io/contributors/Aaron%20Levitt.html
+  image_url: https://www.opencaesar.io/assets/img/aaron.jpeg
diff --git a/docs/api-documentation/_category_.json b/docs/api-documentation/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "API Documentation",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "API documentation for OML Vision."
+  }
+}
diff --git a/docs/api-documentation/config.md b/docs/api-documentation/config.md
@@ -0,0 +1,68 @@
+---
+sidebar_position: 2
+---
+
+# Config
+
+The config or configuration directory contains the configuration the following API endpoints for the in-memory [Fuseki](https://jena.apache.org/documentation/fuseki2/) RDF triplestore:
+
+- query
+- update
+
+<!-- TODO: Change example to opencaesar organization -->
+An example of a config directory correctly formatted for OML Vision can be seen [here](https://github.com/pogi7/kepler16b-example/blob/main/src/vision/config/sparqlConfig.json)
+
+## sparqlConfig.json
+
+:::info sparqlConfig.json
+
+Create a `src/vision/config/sparqlConfig.json` file (case-sensitive)
+
+:::
+
+The `src/vision/config/sparqlConfig.json` file is responsible for specifying the query and update API endpoints.
+
+It is formatted as a JSON data structure.
+
+<!-- TODO: Change to opencaesar repo -->
+An example of what this looks like is seen below with the source code found [here](https://github.com/pogi7/kepler16b-example/blob/main/src/vision/config/sparqlConfig.json)
+
+```json
+{
+  "queryEndpoint": "http://localhost:3030/tutorial2/sparql",
+  "updateEndpoint": "http://localhost:3030/tutorial2/update"
+}
+```
+
+### queryEndpoint
+
+:::danger REQUIRED
+
+```typescript
+queryEndpoint: string
+```
+
+:::
+
+This string defines the API query endpoint of the in-memory RDF triplestore.  
+
+#### Fuseki
+
+<!-- TODO: Change to opencaesar repo -->
+This endpoint can usually be found within the `.fuseki.ttl` file under the `sparql` service.  An example of how to specify this endpoint can be found [here](https://github.com/pogi7/kepler16b-example/blob/main/.fuseki.ttl#L15)
+
+### updateEndpoint
+:::danger REQUIRED
+
+```typescript
+updateEndpoint: string
+```
+
+:::
+
+This string defines the API update endpoint of the in-memory RDF triplestore.  
+
+#### Fuseki
+
+<!-- TODO: Change to opencaesar repo -->
+This endpoint can usually be found within the `.fuseki.ttl` file under the `update` service.  An example of how to specify this endpoint can be found [here](https://github.com/pogi7/kepler16b-example/blob/main/.fuseki.ttl#L14)
diff --git a/docs/api-documentation/gradle.md b/docs/api-documentation/gradle.md
@@ -0,0 +1,75 @@
+---
+sidebar_position: 5
+---
+
+# Gradle
+
+OML models tend to use Gradle to package dependencies and tasks to manipulate and analyze the model.
+
+:::danger Gradle for Java VSCode Extension
+
+OML Vision requires the [Gradle for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-gradle) VSCode extension.  
+
+Read more installation instructions [here](docs/intro#what-youll-need)
+
+:::
+
+## Build
+
+:::info build.gradle
+
+Create a `build.gradle` file (case-sensitive)
+
+:::
+
+In OML Vision, the `build.gradle` file is responsible for: 
+
+- Defining tasks to run in OML Vision
+- Listens on the `build.gradle` file for any changes.  
+
+Examples of correctly formatted `build.gradle` files for OML Vision are found here:
+
+- [Kepler16b build.gradle](https://github.com/pogi7/kepler16b-example/blob/main/build.gradle)
+- [Open Source Rover build.gradle](https://github.com/UTNAK/open-source-rover/blob/main/build.gradle)
+
+You can read more about `build.gradle` files [here](https://docs.gradle.org/current/userguide/build_file_basics.html)
+
+## Tasks
+
+A task in Gradle refers to some command or program that Gradle executes.
+
+Generally OML Vision only requires 5 tasks:
+
+- clean (Removes build folder)
+- build (Constructs OWL and OML files)
+- startFuseki (starts RDF triplestore)
+- owlLoad (Loads OWL data into RDF triplestore)
+- stopFuseki (stops RDF triplestore)
+
+### Vision Group
+
+OML Vision is asynchronously listening in the `build.gradle` for any changes to the tasks.  OML Vision will display any task in the `vision` group in the sidebar.
+
+:::note REGISTERING NEW GRADLE TASKS
+
+New tasks will register once you deactivate then reactive OML Vision.  You can do this by clicking the [File Explorer](https://code.visualstudio.com/docs/getstarted/userinterface#_explorer) then clicking the OML Vision extension icon.
+
+:::
+
+**By default, OML Vision displays the `clean` and `build` tasks.  Those tasks do not need to be within the `vision` Gradle group.**
+
+:::tip USER INTERFACE
+
+The `vision` gradle corresponds to the `Setup Tasks` section in OML Vision shown in the red boxes.
+
+![Gradle Tasks](./img/gradleTasks.png)
+
+:::
+
+### Running Tasks
+
+You may run tasks in OML Vision either 
+
+- By clicking the `Run Task` button in the OML Vision extension under the `Setup Tasks` section 
+- Running the task using the Gradle wrapper in any terminal.
+  - An example of this would be running `./gradlew clean`
diff --git a/docs/api-documentation/img/correctJavaVersion.png b/docs/api-documentation/img/correctJavaVersion.png
diff --git a/docs/api-documentation/img/gradleTasks.png b/docs/api-documentation/img/gradleTasks.png
diff --git a/docs/api-documentation/img/noRequiredDirectories.png b/docs/api-documentation/img/noRequiredDirectories.png
diff --git a/docs/api-documentation/img/portAlreadyUsed.png b/docs/api-documentation/img/portAlreadyUsed.png
diff --git a/docs/api-documentation/layouts/_category_.json b/docs/api-documentation/layouts/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Layouts",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "API documentation for layouts within OML Vision."
+  }
+}