Add documentation files and update configuration for Docs service

Author: simlarsen

.vscode/launch.json

@@ -105,6 +105,20 @@
             "restart": true,
             "autoAttachChildProcesses": true
         },
+        {
+            "address": "127.0.0.1",
+            "localRoot": "${workspaceFolder}/Worker",
+            "name": "Docs: Debug with Docker",
+            "port": 8738,
+            "remoteRoot": "/usr/src/app",
+            "request": "attach",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node",
+            "restart": true,
+            "autoAttachChildProcesses": true
+        },
         {
             "address": "127.0.0.1",
             "localRoot": "${workspaceFolder}/Worker",

App/Index.ts

@@ -1,5 +1,5 @@
 import BaseAPIRoutes from "./FeatureSet/BaseAPI/Index";
-import DocsRoutes from "./FeatureSet/Docs/Index";
+import DocsRoutes from "../Docs/Routes";
 // import FeatureSets.
 import IdentityRoutes from "./FeatureSet/Identity/Index";
 import NotificationRoutes from "./FeatureSet/Notification/Index";

Docs/.dockerignore

@@ -0,0 +1,56 @@
+.git
+
+node_modules
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+node_modules
+
+.idea
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+
+env.js
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+yarn.lock
+Untitled-1
+*.local.sh
+*.local.yaml
+run
+stop
+
+nohup.out*
+
+encrypted-credentials.tar
+encrypted-credentials/
+
+_README.md
+
+# Important Add production values to gitignore.
+values-saas-production.yaml
+kubernetes/values-saas-production.yaml
+
+/private
+
+/tls_cert.pem
+/tls_key.pem
+/keys
+
+temp_readme.md
+
+tests/coverage
+
+settings.json
+
+GoSDK/tester/

Docs/.gitattributes

@@ -0,0 +1 @@
+*.js text eol=lf

Docs/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+#/backend/node_modules
+/kubernetes
+/node_modules
+.idea
+
+# misc
+.DS_Store
+
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+yarn.lock
+
+**/*/paymentService.test.js
+apiTest.rest
+
+application_security_dir
+container_security_dir
+
+# coverage
+/coverage
+/.nyc_output
+
+/greenlock.d/config.json
+/greenlock.d/config.json.bak
+/.greenlockrc

App/FeatureSet/Docs/Content/copilot/deploy-llm-server.md renamed to Docs/Content/copilot/deploy-llm-server.md

@@ -0,0 +1,70 @@
+#
+# OneUptime-App Dockerfile
+#
+
+# Pull base image nodejs image.
+FROM node:21.2-alpine3.18
+RUN mkdir /tmp/npm &&  chmod 2777 /tmp/npm && chown 1000:1000 /tmp/npm && npm config set cache /tmp/npm --global
+
+RUN npm config set fetch-retries 5
+RUN npm config set fetch-retry-mintimeout 100000
+RUN npm config set fetch-retry-maxtimeout 600000
+
+
+
+ARG GIT_SHA
+ARG APP_VERSION
+
+ENV GIT_SHA=${GIT_SHA}
+ENV APP_VERSION=${APP_VERSION}
+
+
+# IF APP_VERSION is not set, set it to 1.0.0
+RUN if [ -z "$APP_VERSION" ]; then export APP_VERSION=1.0.0; fi
+
+
+# Install bash. 
+RUN apk add bash && apk add curl
+
+
+# Install python
+RUN apk update && apk add --no-cache --virtual .gyp python3 make g++
+
+#Use bash shell by default
+SHELL ["/bin/bash", "-c"]
+
+
+RUN mkdir /usr/src
+
+WORKDIR /usr/src/Common
+COPY ./Common/package*.json /usr/src/Common/
+# Set version in ./Common/package.json to the APP_VERSION
+RUN sed -i "s/\"version\": \".*\"/\"version\": \"$APP_VERSION\"/g" /usr/src/Common/package.json
+RUN npm install
+COPY ./Common /usr/src/Common
+
+ENV PRODUCTION=true
+
+WORKDIR /usr/src/app
+
+# Install app dependencies
+COPY ./Docs/package*.json /usr/src/app/
+# Set version in ./App/package.json to the APP_VERSION
+RUN sed -i "s/\"version\": \".*\"/\"version\": \"$APP_VERSION\"/g" /usr/src/app/package.json
+RUN npm install
+
+# Expose ports.
+#   - 1447: OneUptime-Docs
+EXPOSE 1447
+
+{{ if eq .Env.ENVIRONMENT "development" }}
+#Run the app
+CMD [ "npm", "run", "dev" ]
+{{ else }}
+# Copy app source
+COPY ./Docs /usr/src/app
+# Bundle app source
+RUN npm run compile
+#Run the app
+CMD [ "npm", "start" ]
+{{ end }}

App/FeatureSet/Docs/Content/copilot/introduction.md renamed to Docs/Content/copilot/introduction.md

@@ -0,0 +1,51 @@
+import DocsRoutes from "./Routes";
+import { PromiseVoidFunction } from "Common/Types/FunctionTypes";
+import InfrastructureStatus from "Common/Server/Infrastructure/Status";
+import logger from "Common/Server/Utils/Logger";
+import App from "Common/Server/Utils/StartServer";
+import Telemetry from "Common/Server/Utils/Telemetry";
+import "ejs";
+
+const APP_NAME: string = "docs";
+
+const init: PromiseVoidFunction = async (): Promise<void> => {
+  try {
+    // Initialize telemetry
+    Telemetry.init({
+      serviceName: APP_NAME,
+    });
+
+    const statusCheck: PromiseVoidFunction = async (): Promise<void> => {
+      // Check the status of infrastructure components
+      return await InfrastructureStatus.checkStatus({
+        checkClickhouseStatus: false,
+        checkPostgresStatus: false,
+        checkRedisStatus: false,
+      });
+    };
+
+    // Initialize the app with service name and status checks
+    await App.init({
+      appName: APP_NAME,
+      statusOptions: {
+        liveCheck: statusCheck,
+        readyCheck: statusCheck,
+      },
+    });
+
+    await DocsRoutes.init();
+
+    // Add default routes to the app
+    await App.addDefaultRoutes();
+  } catch (err) {
+    logger.error("App Init Failed:");
+    logger.error(err);
+    throw err;
+  }
+};
+
+init().catch((err: Error) => {
+  logger.error(err);
+  logger.error("Exiting node process");
+  process.exit(1);
+});

App/FeatureSet/Docs/Content/installation/docker-compose.md renamed to Docs/Content/installation/docker-compose.md

@@ -0,0 +1,86 @@
+import AuthenticationServiceHandler from "./Service/Authentication";
+import DataTypeServiceHandler from "./Service/DataType";
+import ErrorServiceHandler from "./Service/Errors";
+import IntroductionServiceHandler from "./Service/Introduction";
+import ModelServiceHandler from "./Service/Model";
+import PageNotFoundServiceHandler from "./Service/PageNotFound";
+import PaginationServiceHandler from "./Service/Pagination";
+import PermissionServiceHandler from "./Service/Permissions";
+import StatusServiceHandler from "./Service/Status";
+import { StaticPath } from "./Utils/Config";
+import ResourceUtil, { ModelDocumentation } from "./Utils/Resources";
+import Dictionary from "Common/Types/Dictionary";
+import FeatureSet from "Common/Server/Types/FeatureSet";
+import Express, {
+  ExpressApplication,
+  ExpressRequest,
+  ExpressResponse,
+  ExpressStatic,
+} from "Common/Server/Utils/Express";
+
+const APIReferenceFeatureSet: FeatureSet = {
+  init: async (): Promise<void> => {
+    const ResourceDictionary: Dictionary<ModelDocumentation> =
+      ResourceUtil.getResourceDictionaryByPath();
+
+    const app: ExpressApplication = Express.getExpressApp();
+
+    // Serve static files for the API reference with a cache max age of 30 days
+    app.use("/reference", ExpressStatic(StaticPath, { maxAge: 2592000 }));
+
+    // Redirect index page to the introduction page
+    app.get(["/reference"], (_req: ExpressRequest, res: ExpressResponse) => {
+      return res.redirect("/reference/introduction");
+    });
+
+    // Handle "Page Not Found" page
+    app.get(
+      ["/reference/page-not-found"],
+      (req: ExpressRequest, res: ExpressResponse) => {
+        return PageNotFoundServiceHandler.executeResponse(req, res);
+      },
+    );
+
+    // Handle all other pages based on the "page" parameter
+    app.get(
+      ["/reference/:page"],
+      (req: ExpressRequest, res: ExpressResponse) => {
+        const page: string | undefined = req.params["page"];
+
+        if (!page) {
+          return PageNotFoundServiceHandler.executeResponse(req, res);
+        }
+
+        const currentResource: ModelDocumentation | undefined =
+          ResourceDictionary[page];
+
+        // Execute the appropriate service handler based on the "page" parameter
+        if (req.params["page"] === "permissions") {
+          return PermissionServiceHandler.executeResponse(req, res);
+        } else if (req.params["page"] === "authentication") {
+          return AuthenticationServiceHandler.executeResponse(req, res);
+        } else if (req.params["page"] === "pagination") {
+          return PaginationServiceHandler.executeResponse(req, res);
+        } else if (req.params["page"] === "errors") {
+          return ErrorServiceHandler.executeResponse(req, res);
+        } else if (req.params["page"] === "introduction") {
+          return IntroductionServiceHandler.executeResponse(req, res);
+        } else if (req.params["page"] === "status") {
+          return StatusServiceHandler.executeResponse(req, res);
+        } else if (req.params["page"] === "data-types") {
+          return DataTypeServiceHandler.executeResponse(req, res);
+        } else if (currentResource) {
+          return ModelServiceHandler.executeResponse(req, res);
+        }
+        // page not found
+        return PageNotFoundServiceHandler.executeResponse(req, res);
+      },
+    );
+
+    app.get("/reference/*", (req: ExpressRequest, res: ExpressResponse) => {
+      return PageNotFoundServiceHandler.executeResponse(req, res);
+    });
+  },
+};
+
+export default APIReferenceFeatureSet;

App/FeatureSet/Docs/Content/installation/local-development.md renamed to Docs/Content/installation/local-development.md

@@ -0,0 +1,8 @@
+{
+    "watch": ["./","../Common/Server", "../Common/Types", "../Common/Utils", "../Common/Models"],
+    "ext": "ts,json,tsx,env,js,jsx,hbs",
+    "ignore": [
+        "greenlock.d/*"
+    ],
+    "exec": "node --inspect=0.0.0.0:9229 --require ts-node/register Index.ts"
+}