Merge pull request #69 from haarer/main

make new style documentation available

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct

.github/workflows/pages.yml

@@ -0,0 +1,62 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,15 @@
+# Not sure what a .gitignore is?
+# See: https://git-scm.com/docs/gitignore
+
+# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
+# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
+
+# Ignore the default location of the built site, and caches and metadata generated by Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/

Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.3.3" # installed by `gem jekyll`
+# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+
+#gem "just-the-docs", "0.9.0" # pinned to the current release
+gem "just-the-docs"       # always download the latest release
+
+gem 'jekyll-relative-links'

Gemfile.lock

@@ -0,0 +1,94 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    bigdecimal (3.1.8)
+    colorator (1.1.0)
+    concurrent-ruby (1.3.4)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.17.0-x64-mingw-ucrt)
+    ffi (1.17.0-x86_64-linux-gnu)
+    forwardable-extended (2.6.0)
+    google-protobuf (4.28.2-x64-mingw-ucrt)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.28.2-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
+    http_parser.rb (0.8.0)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.4)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-relative-links (0.7.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    just-the-docs (0.10.0)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (6.0.1)
+    rake (13.2.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rexml (3.3.8)
+    rouge (4.4.0)
+    safe_yaml (1.0.5)
+    sass-embedded (1.79.4-x64-mingw-ucrt)
+      google-protobuf (~> 4.27)
+    sass-embedded (1.79.4-x86_64-linux-gnu)
+      google-protobuf (~> 4.27)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.6.0)
+    webrick (1.8.2)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86_64-linux
+
+DEPENDENCIES
+  jekyll (~> 4.3.3)
+  jekyll-relative-links
+  just-the-docs
+
+BUNDLED WITH
+   2.5.18

_config.yml

@@ -0,0 +1,37 @@
+title: System Architecture Framework
+description: A scalable SysML Based Framework to foster MBSE for multiple Modeling Tools!
+theme: just-the-docs
+source: src
+
+url: https://just-the-docs.github.io
+
+aux_links:
+  GfSE Home Page: https://gfse.org
+
+
+logo: "/assets/images/Banner_SAF_gross.png"
+
+
+plugins:
+  - jekyll-relative-links
+
+
+
+relative_links:
+  enabled:     true
+
+callouts:
+  highlight:
+    color: yellow
+  important:
+    title: Important
+    color: blue
+  new:
+    title: New
+    color: green
+  todo:
+    title: ToDo
+    color: purple
+  warning:
+    title: Warning
+    color: red

src/_data/aspects.json

@@ -0,0 +1,41 @@
+[ {
+  "ID" : "_19_0_2_8710274_1573477769334_411734_55347",
+  "Name" : "Context & Exchange",
+  "AspectID" : "1",
+  "Documentation" : "Identifies and describes the environment of an element, its boundary, and the external elements having a relation with it. It identifies the interaction and exchange between an element and the external elements."
+}, {
+  "ID" : "_19_0_2_8710274_1573478263296_178397_55752",
+  "Name" : "Taxonomy & Structure",
+  "AspectID" : "2",
+  "Documentation" : "Identifies and describes the breakdown and decomposition of elements and defines the dependencies and relationships between the different elements."
+}, {
+  "ID" : "_19_0_2_8710274_1573478271003_747028_55755",
+  "Name" : "Process & Behavior",
+  "AspectID" : "3",
+  "Documentation" : "Captures functions, activities, processes, and flows. Identifies and describes activities, their inputs and outputs, activity actions, and flows between them. Captures state-based behavior of an element. It is a graphical representation of states of a structural element and how it responds to various events and actions."
+}, {
+  "ID" : "_19_0_2_8710274_1573478279723_738954_55758",
+  "Name" : "Interaction & Collaboration",
+  "AspectID" : "4",
+  "Documentation" : "Identifies and describes time-ordered examination of exchanges between participating elements as a result of a particular scenario."
+}, {
+  "ID" : "_19_0_2_8710274_1573478299847_198747_55761",
+  "Name" : "Interface",
+  "AspectID" : "5",
+  "Documentation" : "[tbd]"
+}, {
+  "ID" : "_19_0_2_8710274_1573478310642_402706_55764",
+  "Name" : "Requirement",
+  "AspectID" : "6",
+  "Documentation" : "[tbd]"
+}, {
+  "ID" : "_19_0_2_8710274_1573478328161_943945_55767",
+  "Name" : "Safety & Security",
+  "AspectID" : "7",
+  "Documentation" : "[tbd]"
+}, {
+  "ID" : "_19_0_2_8710274_1573478339752_58845_55770",
+  "Name" : "Traceability & Mapping",
+  "AspectID" : "8",
+  "Documentation" : "Traceability\nIdentifies and describes the traceability between requirements or standards and model elements in the various domains and viewpoints.\nMapping\nIdentifies and describes the mapping between elements in the architecture. This may be between different viewpoints within domains as well as between domains. It may also be between structure and behaviors, too."
+} ]