Laserfiche · rfulton-lf · Sep 28, 2023 · Aug 16, 2023 · Aug 16, 2023 · Aug 16, 2023
diff --git a/.github/workflows/jekyll_gh_pages.yml b/.github/workflows/jekyll_gh_pages.yml
@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy SharePoint Integration Documentation
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["1.x"]
+
+  # 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./jekyll_files
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+
+  # 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@v2
diff --git a/.gitignore b/.gitignore
@@ -12,7 +12,6 @@ lib
 release
 solution
 temp
-*.sppkg
 
 # Coverage directory used by tools like istanbul
 coverage
@@ -31,5 +30,8 @@ obj
 
 # Styles Generated Code
 *.scss.ts
+output.css
+.heft/
 
-.heft/
+# locally generated documentation
+jekyll_files/_site/
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,6 +1,7 @@
 {
   "recommendations": [
     "msjsdiag.debugger-for-chrome",
-    "esbenp.prettier-vscode"
+    "esbenp.prettier-vscode",
+    "bradlc.vscode-tailwindcss"
   ]
-}
+}
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # laserfiche-sharepoint-integration
-
+[Documentation](https://laserfiche.github.io/laserfiche-sharepoint-integration/)
 ## Summary
 
-This project, built with React, contains 3 Sharepoint WebParts that can be used to communicate with Laserfiche.
+This project, built with React, contains 3 SharePoint web parts that can be used to communicate with Laserfiche. To learn more about web parts, consult Microsoft's documentation for [using them](https://support.microsoft.com/en-us/office/using-web-parts-on-sharepoint-pages-336e8e92-3e2d-4298-ae01-d404bbe751e0) and [building them](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part).
 
 ## Prerequisites
 
@@ -18,12 +18,40 @@ We welcome contributions and feedback. Please follow our [contributing guideline
 
 ---
 
-## To run locally
-
-- Clone this repository
+## To run locally in your SharePoint Workbench
 - Ensure that you are at the solution folder
-  - **npm install**
-  - **npm run gulp-trust-dev-cert**
+  - run **npm install**
+  - run **npm run gulp-trust-dev-cert**
   - Replace `REPLACE_WITH_YOUR_SHAREPOINT_SITE` in serve.json with your sharepoint site
-  - **npm run serve**
+  - run **npm run serve**
+    - this should open up a window in the browser called a SharePoint workbench. 
   - To use a.clouddev.laserfiche.com: Open browser dev tools and go to site Local Storage: set 'spDevMode' to true
+
+## To test in a SharePoint site using localhost
+- run **npm install**
+- **npm run build**
+- **npm run package**
+- this should result in the creation of a file with the path `/sharepoint/solution/laserfiche-sharepoint-integration.sppkg` from the root folder.
+- Navigate to the solution folder
+- run **npm run gulp-trust-dev-cert** (one-time only)
+- Replace `REPLACE_WITH_YOUR_SHAREPOINT_SITE` in serve.json with your sharepoint site
+- run **npm run serve** to host the code for the integration
+- reference the [Admin Documentation](https://laserfiche.github.io/laserfiche-sharepoint-integration/docs/admin-documentation) for instructions on how to use the solution file you generated in the first steps to test your changes to the web parts in SharePoint sites.
+
+## To test in a SharePoint site with files hosted by SharePoint
+- run **npm install**
+- **npm run bundle**
+- **npm run package-solution**
+- This will create the solution file at /sharepoint/solution/laserfiche-sharepoint-integration.sppkg.
+- Once you've built and packaged the solution file, you can use it as a production package and upload it in the SharePoint admin center (see [Admin Docs](https://laserfiche.github.io/laserfiche-sharepoint-integration/docs/admin-documentation))
+
+## To build documentation locally
+1. Follow the instructions [here](https://jekyllrb.com/docs/) to install jekyll and bundler.
+    - if any dependency installation fails, try downloading the package manually.
+    - navigate to the download directory.
+    - run `gem install problematic-dependency-name`, where the last word is replaced by the package you downloaded manually.
+    - retry installing the original package now that its dependency is installed.
+1. Run `bundle install`  to install all the dependencies needed to serve.
+1. Navigate to the `jekyll_files` directory.
+1. Run `bundle exec jekyll serve` to serve the documentation.
+1. Open `localhost:4000` in a browser.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/styles.css b/docs/styles.css
diff --git a/jekyll_files/Gemfile b/jekyll_files/Gemfile
@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+gemspec
+
+# gem "jekyll-github-metadata", ">= 2.15"
+
+gem "jekyll-include-cache", group: :jekyll_plugins
+
+gem "html-proofer", "~> 5.0", :group => :development
diff --git a/jekyll_files/Gemfile.lock b/jekyll_files/Gemfile.lock
@@ -0,0 +1,135 @@
+PATH
+  remote: .
+  specs:
+    LaserficheDocs (0.0.1)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.1.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    afm (0.2.2)
+    async (2.6.4)
+      console (~> 1.10)
+      fiber-annotation
+      io-event (~> 1.1)
+      timers (~> 4.1)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.2)
+    console (1.23.2)
+      fiber-annotation
+      fiber-local
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    fiber-annotation (0.2.0)
+    fiber-local (1.0.0)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.24.3-x64-mingw-ucrt)
+    google-protobuf (3.24.3-x86_64-linux)
+    hashery (2.1.2)
+    html-proofer (5.0.8)
+      addressable (~> 2.3)
+      async (~> 2.1)
+      nokogiri (~> 1.13)
+      pdf-reader (~> 2.11)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+      zeitwerk (~> 2.5)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-event (1.3.2)
+    jekyll (4.3.2)
+      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-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)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    nokogiri (1.15.4-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    pdf-reader (2.11.0)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.6)
+    rouge (4.1.3)
+    ruby-rc4 (0.1.5)
+    safe_yaml (1.0.5)
+    sass-embedded (1.66.1-x64-mingw-ucrt)
+      google-protobuf (~> 3.23)
+    sass-embedded (1.66.1-x86_64-linux-gnu)
+      google-protobuf (~> 3.23)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    timers (4.3.5)
+    ttfunk (1.7.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
+    yell (2.2.2)
+    zeitwerk (2.6.11)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86_64-linux
+
+DEPENDENCIES
+  LaserficheDocs!
+  bundler (>= 2.3.5)
+  html-proofer (~> 5.0)
+  jekyll-include-cache
+
+BUNDLED WITH
+   2.3.26
diff --git a/jekyll_files/LaserficheDocs.gemspec b/jekyll_files/LaserficheDocs.gemspec
@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "LaserficheDocs"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Laserfiche"]
+
+  spec.summary       = %q{Jekyll theme for Laserfiche Technical Documentation based on Just-The-Docs}
+  spec.homepage      = "https://github.com/Laserfiche/laserfiche-sharepoint-integration"
+  spec.license       = "MIT"
+  spec.metadata      = {
+    "bug_tracker_uri"   => "https://github.com/Laserfiche/laserfiche-sharepoint-integration/issues",
+    "changelog_uri"     => "https://github.com/Laserfiche/laserfiche-sharepoint-integration/CHANGELOG.md",
+    "documentation_uri" => "https://laserfiche.github.io/laserfiche-sharepoint-integration/",
+    "source_code_uri"   => "https://github.com/Laserfiche/laserfiche-sharepoint-integration",
+  }
+
+  spec.add_development_dependency "bundler", ">= 2.3.5"
+  spec.add_runtime_dependency "jekyll", ">= 3.8.5"
+  spec.add_runtime_dependency "jekyll-seo-tag", ">= 2.0"
+  spec.add_runtime_dependency "jekyll-include-cache"
+  spec.add_runtime_dependency "rake", ">= 12.3.1"
+end
diff --git a/jekyll_files/README.md b/jekyll_files/README.md
@@ -0,0 +1 @@
+The styles here are adapted from the [Just-The-Docs](https://github.com/just-the-docs/just-the-docs) jekyll theme. 
diff --git a/jekyll_files/_config.yml b/jekyll_files/_config.yml
@@ -0,0 +1,66 @@
+# Jekyll Documentation Generator Configuration File
+
+title: Laserfiche SharePoint Online Integration
+
+exclude:
+ # from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
+   - .sass-cache/
+   - .jekyll-cache/
+   - gemfiles/
+   - Gemfile
+   - Gemfile.lock
+   - node_modules/
+   - vendor/bundle/
+   - vendor/cache/
+   - vendor/gems/
+   - vendor/ruby/
+ # specific to the theme website:
+   - bin/
+   - lib/
+   - "*.gemspec"
+   - "*.gem"
+   - LICENSE.txt
+   - package.json
+   - package-lock.json
+   - Rakefile
+   - README.md
+   - CODE_OF_CONDUCT.md
+   - docker-compose.yml
+   - Dockerfile
+ # theme test code
+   - fixtures/
+
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 2
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 3
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 3
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false
+
+plugins:
+  - jekyll-seo-tag
+  # - jekyll-github-metadata
+  - jekyll-include-cache
+
+heading_anchors: true
+color_scheme: lf-styles
+favicon_ico: "/assets/favicon.webp"
+