Merge pull request #45 from transpara/27-sprint-7-faq

FAQs

.github/styles/config/vocabularies/Doc/accept.txt

@@ -59,3 +59,21 @@ VMware
 Xompass
 Zabbix
 RCSs
+productized
+support@transpara.com
+SLAs
+Aspentech
+Timestream
+Modbus
+Splunk
+telco
+Nordstrom
+Zappos
+Seeq
+architected
+Yokogawa
+Cognite
+SQLuser
+projectware
+picosecond
+lossy

.github/styles/config/vocabularies/docs/accept.txt

@@ -59,3 +59,21 @@ VMware
 Xompass
 Zabbix
 RCSs
+productized
+support@transpara.com
+SLAs
+Aspentech
+Timestream
+Modbus
+Splunk
+telco
+Nordstrom
+Zappos
+Seeq
+architected
+Yokogawa
+Cognite
+SQLuser
+projectware
+picosecond
+lossy

.github/workflows/main.yml

@@ -5,33 +5,56 @@ on:
 
 jobs:
   vale:
-    name: runner-vale
+    name: runner / vale
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      #- uses: errata-ai/vale-action@reviewdog
-      # id: check
-      #with:
-      # version: 2.17.0
-      # github-pr-check, github-pr-review, github-check
-      # reporter: github-pr-review
-      #fail_on_error: true
-      # added, diff_context, file, nofilter
-      # filter_mode: nofilter
-      - name: Get latest version of Vale
-        id: lastversion
-        uses: dvershinin/lastversion-action@v0.0.3
+      - uses: errata-ai/vale-action@reviewdog
         with:
-          repository: errata-ai/vale
+          files: ./visual-kpi-docs/docs
+  # reviewdog:
+  #   name: reviewdog
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - uses: errata-ai/vale-action@reviewdog
+  #       with:
+  #         files: ./visual-kpi-docs/docs
+  #     - uses: reviewdog/action-setup@v1
+  #       with:
+  #         reviewdog_version: latest
+  #     - name: Run reviewdog
+  #       env:
+  #         REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.VALE_TOKEN }}
+  #       run: |
+  #         reviewdog -reporter=github-pr-review -runners=golint,govet
+    # name: runner-vale
+    # runs-on: ubuntu-latest
+    # steps:
+    #   - uses: actions/checkout@v3
+    #   #- uses: errata-ai/vale-action@reviewdog
+    #   # id: check
+    #   #with:
+    #   # version: 2.17.0
+    #   # github-pr-check, github-pr-review, github-check
+    #   # reporter: github-pr-review
+    #   #fail_on_error: true
+    #   # added, diff_context, file, nofilter
+    #   # filter_mode: nofilter
+    #   - name: Get latest version of Vale
+    #     id: lastversion
+    #     uses: dvershinin/lastversion-action@main
+    #     with:
+    #       repository: errata-ai/vale-action
 
-      - name: Install Vale
-        run: |
-          wget https://github.com/errata-ai/vale/releases/download/v${{ steps.lastversion.outputs.last_version }}/vale_${{ steps.lastversion.outputs.last_version }}_Linux_64-bit.tar.gz -O vale.tar.gz
-          tar -xvzf vale.tar.gz vale
-          rm vale.tar.gz
+    #   - name: Install Vale
+    #     run: |
+    #       wget https://github.com/errata-ai/vale/releases/download/v${{ steps.lastversion.outputs.last_version }}/vale_${{ steps.lastversion.outputs.last_version }}_Linux_64-bit.tar.gz -O vale.tar.gz
+    #       tar -xvzf vale.tar.gz vale
+    #       rm vale.tar.gz
 
-      #- name: Validate the syntax
-      #  run: ./vale --config=.vale.ini *.md
+    #   #- name: Validate the syntax
+    #   #  run: ./vale --config=.vale.ini *.md
 
-      - name: Validate the syntax
-        run: ./vale ./visual-kpi-docs/docs
+      # - name: Validate the syntax
+      #   run: ./vale ./visual-kpi-docs/docs

.reviewdog.yml

@@ -0,0 +1,36 @@
+runner:
+  golint:
+    cmd: golint $(go list ./... | grep -v /vendor/)
+    format: golint
+    level: warning
+  govet:
+    cmd: go vet $(go list ./... | grep -v /vendor/)
+    format: govet
+  errcheck:
+    cmd: errcheck -asserts -ignoretests -blank $(go list ./... | grep -v /vendor/)
+    errorformat:
+      - "%f:%l:%c:%m"
+    level: warning
+  staticcheck:
+    cmd: staticcheck $(go list ./... | grep -v /vendor/)
+    errorformat:
+      - "%f:%l:%c: %m"
+  misspell:
+    cmd: misspell $(git ls-files)
+    errorformat:
+      - "%f:%l:%c: %m"
+  unparam:
+    cmd: unparam $(go list ./... | grep -v /vendor/)
+    errorformat:
+      - "%f:%l:%c: %m"
+  revive:
+    cmd: revive -config=.revive.toml $(go list ./... | grep -v /vendor/)
+    format: golint
+    level: warning
+  golangci:
+    cmd: golangci-lint run --out-format=line-number ./...
+    errorformat:
+      - '%E%f:%l:%c: %m'
+      - '%E%f:%l: %m'
+      - '%C%.%#'
+    level: warning

visual-kpi-docs/.sidebar/supporting-pages/index.js

@@ -1,8 +1,8 @@
 module.exports = [
   {
     type: 'doc',
-    id: 'supporting-pages/faq',
-    label: 'FAQ',
+    id: 'supporting-pages/faqs',
+    label: 'FAQs',
   },
   {
     type: 'doc',

visual-kpi-docs/docs/get-started/access-level.mdx

@@ -2,6 +2,6 @@
 id: access-level
 title: Access Levels
 slug: /get-started/access-level
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/data-update-and-timestamp.mdx

@@ -2,6 +2,6 @@
 id: data-update-and-timestamp
 title: Data Update and Timestamp
 slug: /get-started/data-update-and-timestamp
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/navigation.mdx

@@ -2,6 +2,6 @@
 id: navigation
 title: Navigation
 slug: /get-started/navigation
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/notifications.mdx

@@ -2,6 +2,6 @@
 id: notifications
 title: Notifications
 slug: /get-started/notifications
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/objects.mdx

@@ -2,6 +2,6 @@
 id: objects
 title: Objects
 slug: /get-started/objects
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/overview.mdx

@@ -2,6 +2,6 @@
 id: overview
 title: Get Started
 slug: /get-started
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/visual-kpi-core-concepts.mdx

@@ -2,6 +2,6 @@
 id: visual-kpi-core-concepts
 title: Visual KPI Core Concepts
 slug: /get-started/visual-kpi-core-concepts
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/get-started/ways-to-use-visual-kpis.mdx

@@ -2,6 +2,6 @@
 id: ways-to-use-visual-kpi
 title: Ways to Use Visual KPI
 slug: /get-started/ways-to-use-visual-kpi
-description: 'no description'
+description: ''
 tags: []
 ---

visual-kpi-docs/docs/how-to-use-the-documentation.mdx

@@ -32,7 +32,7 @@ In addition to these tailored sections, Visual KPI documentation provides suppor
 
 - [Reference guides](/docs/references): These provide detailed documentation and information for users to refer to when they need in-depth knowledge or assistance regarding specific Visual KPI functionalities.
 
-- [Frequently Asked Questions (FAQs)](/docs/faq): This section contains answers to common questions and issues that users may encounter while using Visual KPI, offering quick solutions.
+- [Frequently Asked Questions (FAQs)](/docs/faqs): This section contains answers to common questions and issues that users may encounter while using Visual KPI, offering quick solutions.
 
 - [Troubleshooting resources](/docs/troubleshooting): If you come across any errors while using Visual KPI, such as interface connection issues or when attempting to verify SQL-related problems, it's advisable to consult the troubleshooting suggestions for assistance.
 

visual-kpi-docs/docs/setup-and-administration/installation/prepare-your-system.mdx

@@ -143,6 +143,39 @@ Below you find this steps exemplified:
   alt="sql-manager setup"
 />
 
+### Confirm SQL Installation and Permissions
+
+To install the Visual KPI Server and ensure that it operates as expected, you'll need SQL Server with admin or better permissions enabled.
+
+:::info
+This refers to the SQL Server database that's used by Visual KPI for all configuration information. This database is essential for Visual KPI to function correctly. It should be noted that this doesn't apply to using SQL Server as a source of data at runtime as an interface, which is also possible.
+:::
+
+Make sure you have access to SQL Server somewhere on the network or locally. You aren't required to install it locally, but Visual KPI does require that SQL Management Studio client tools be stored locally so that changes can be made or permissions can be managed.
+
+Before you start the Visual KPI installation, check your privileges on the SQL Server. The logged-in user must have certain privileges on the SQL Server as the Visual KPI Server is being installed. Because the Visual KPI database needs read and write permissions to the SQL Server, you'll need the following privileges, depending on the task:
+
+- **Installation of Visual KPI**: Local admin on the Windows Server machine for the installing user. For SQL Server, you must have rights to create and delete databases, execute stored procedures, add tables/views and drop tables/views.
+- **Upgrading and maintaining Visual KPI**: Local admin on the Windows Server machine for the user. For SQL Server, you must have rights to execute stored procedures, add tables/views and drop tables/views.
+- **Runtime requirements**: For the Visual KPI Server to communicate with the SQL Server database, there needs to be an account which has read and write permissions on the Visual KPI database. This account can be one of the following types:
+    - Local SQL Server account: **SQLuser**.
+    - Local machine account: **NT AUTHORITY\NETWORK SERVICE**.
+    - Domain service account: **YOUR_DOMAIN\svc_vkpi**.
+
+By default, Visual KPI uses **NT AUTHORITY\NETWORK SERVICE** as the account for accessing SQL Server, running IIS application pools and executing Windows Services. The is a “least privileges” account and is the preferred choice for the runtime user account with the following characteristics based on single-machine or separate machine deployment:
+
+- **Single-machine**: When the Visual KPI Server and SQL Server coexist on the same Windows Server, IIS connects to SQL Server as NT AUTHORITY\NETWORK SERVICE.
+- **Separate machine**: When the Visual KPI Server and SQL Server are installed on separate Windows Servers, IIS connects to SQL Server as `[YOUR_DOMAIN]\[your Visual KPI server name]$` (for example, `TRANSPARA\VKPI_1$` where Transpara is the domain name and VKPI_1 is the Windows Server name).
+
+#### To confirm SQL Server permissions
+
+To confirm SQL Server permissions you need to do the following:
+
+1. Open Microsoft SQL Server Management Studio client tools.
+2. Expand Security and then expand Logins and make sure your account has sufficient rights for installing Visual KPI Server.
+3. Click on your login and check Server Roles by clicking in the Login Properties panel that opens.
+4. Make sure security admin or higher is checked, or that you meet the requirement as specified above.
+
 ## Visual KPI Server Manager
 
 After performing all steps above, your system is ready to have Visual KPI Server Manager installed. To learn how to install our system, refer to the [Install Visual KPI](/docs/setup-and-administration/installation/install-visual-kpi) page.

visual-kpi-docs/docs/supporting-pages/faq.mdx

@@ -1,11 +1,72 @@
 ---
-id: faq
-title: FAQ
-slug: /faq
-description: 'no description'
-tags: []
+id: faqs
+title: Frequently Asked Questions
+slug: /faqs
+description: 'Frequent asked questions'
+tags: [FAQ]
 ---
 
-In addition to the FAQ we can expose the Frequently Encountered Issues
+import Technical from './faqs/technical.mdx';
+import Implementation from './faqs/implementation.mdx';
+import Integrations from './faqs/integrations.mdx';
+import CostRoi from './faqs/cost-roi.mdx';
+import Competition from './faqs/competition.mdx';
+import UseCases from './faqs/use-cases-customers.mdx';
+import UsingSoftware from './faqs/using-the-software.mdx';
+import Quickstart from './faqs/quickstart-pilot.mdx';
+import SupportServices from './faqs/support-services.mdx';
+import CompanyBackground from './faqs/company-background-history-expertise.mdx';
 
-**Check if the Frequently Encountered Issues should have it's own page**.
+This page contains a list of frequently asked questions (FAQs) that are grouped under different categories. You can find the categories presented below:
+
+- [Technical](#technical-questions)
+- [Implementation](#implementation-questions)
+- [Integrations](#integrations-questions)
+- [Cost & ROI](#cost--roi-questions)
+- [Competition](#competition-questions)
+- [Use Cases & Customers](#use-cases--customers-questions)
+- [Using the Software](#using-the-software-questions)
+- [QuickStart Pilot](#quickstart-pilot-questions)
+- [Support & Services](#support--services-questions)
+- [Company Background, History & Expertise](#company-background-history--expertise-questions)
+
+
+## Technical Questions
+
+<Technical/>
+
+## Implementation Questions
+
+<Implementation/>
+
+## Integrations Questions
+
+<Integrations/>
+
+## Cost & ROI Questions
+
+<CostRoi/>
+
+## Competition Questions
+
+<Competition/>
+
+## Use Cases & Customers Questions
+
+<UseCases/>
+
+## Using the Software Questions
+
+<UsingSoftware/>
+
+## QuickStart Pilot Questions
+
+<Quickstart/>
+
+## Support & Services Questions
+
+<SupportServices/>
+
+## Company Background, History & Expertise Questions
+
+<CompanyBackground/>

visual-kpi-docs/docs/supporting-pages/faqs/company-background-history-expertise.mdx

@@ -0,0 +1,30 @@
+---
+id: company-background-history-expertise
+title: Company Background, History & Expertise
+slug: /faq/company-background-history-expertise
+description: ''
+tags: [FAQ]
+---
+
+import Accordion from '@site/src/components/accordion/Accordion';
+import AccordionGroup from '@site/src/components/accordion/AccordionGroup';
+import SearchWrapper from '@site/src/components/accordion/SearchWrapper';
+
+<SearchWrapper>
+  <AccordionGroup>
+    <Accordion title="Why is Transpara the right company to be doing this? What is your background?">
+      We've deep software and industrial backgrounds, with team members coming from the likes of Microsoft, OSIsoft, Honeywell, Accenture, and Aspen Tech. This is the third software company we've created, and we've a particular passion for productized solutions. With 500+ public releases under our belts, you get to benefit from all that rigor, even if you're not using Transpara in a hardcore, industrial environment. 
+    </Accordion>
+    <Accordion title="How big is Transpara? Where do you have staff?">
+      We're a small but highly active group of contrarians who've been building and releasing industrial-strength enterprise software products for decades. We've thousands of releases under our belts, hundreds of happy customers across more than 25 countries, and the battle scars to prove it.
+    </Accordion>
+    <Accordion title="What are my next steps?">
+      You can move forward in a number of ways. Try these out:
+      - Take the training
+      - Check out our website
+      - Schedule a live demo and Q&A
+      - Engage us for a Quickstart pilot.
+
+    </Accordion>
+  </AccordionGroup>
+</SearchWrapper>