Working Dev docs

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Create CNAME Delete CNAME disable jekyll Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> change to relative path Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> add docs readme Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Adds changelog Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
ashwin-pc · Feb 28, 2024 · c5983bc · c5983bc
1 parent 790c076
commit c5983bc
Show file tree

Hide file tree

Showing 9 changed files with 388 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -90,6 +90,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Add plugin development section in DEVELOPER_GUIDE.md ([#3989](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3989))
 - Remove ftr test step from PR template ([#5217](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5217))
 - [Doc] Update EUI doc site links to point to OUI doc site ([#5293](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5293))
+- Adds Developer Docs generation using Docsify to the repository ([#5977](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5977))
 
 ### 🛠 Maintenance
 

diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md
@@ -0,0 +1,15 @@
+# Welcome to the Developer Guide
+
+Welcome to our Developer Guide! This site is dedicated to providing comprehensive documentation to support developers using OpenSearch Dashboards. Here, you'll find a quick way to access all the readme's that exist within the OpenSearch Dashboards repo in an easy to find manner.
+
+## About This Documentation
+
+The documentation is dynamically generated using [Docsify](https://docsify.js.org/). Docsify dynamically renders the Markdown files into HTML pages without the need for a build step. Docsify uses the documentation directly from the repository. The links in the sidebar are generated based on the folder structure of the repository. To update the links in the sidebar, run `yarn docs:generateDevDocs`.
+
+## Starting Up the Doc Site Locally
+
+To start up the documentation site locally for development or validation purposes, you can simply start a server in the root directory of the repository. `npx serve` is a simple way to start a server. 
+
+---
+
+[Repo Readme](../README.md)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,177 @@
+* [Home](/)
+
+  - Capabilities
+    - [Read_only_mode](capabilities/read_only_mode.md)
+  - Charts
+    - [Current_usage](charts/current_usage.md)
+  - Docker dev
+    - [Docker dev setup manual](docker-dev/docker-dev-setup-manual.md)
+  - Multi datasource
+    - [Client_management_design](multi-datasource/client_management_design.md)
+    - [High_level_design](multi-datasource/high_level_design.md)
+    - [User_stories](multi-datasource/user_stories.md)
+  - Plugins
+    - [Data_persistence](plugins/data_persistence.md)
+  - Saved_objects
+    - [Saved_object_repository_factory_design](saved_objects/saved_object_repository_factory_design.md)
+  - src
+    - [Core](../src/core/README.md)
+    - dev
+      - [Build](../src/dev/build/README.md)
+      - [I18n](../src/dev/i18n/README.md)
+    - plugins
+      - [Bfetch](../src/plugins/bfetch/README.md)
+      - [Charts](../src/plugins/charts/README.md)
+      - console
+        - public
+          - application
+            - [Hooks](../src/plugins/console/public/application/hooks/README.md)
+      - [Dashboard](../src/plugins/dashboard/README.md)
+      - [Data](../src/plugins/data/README.md)
+      - [Data_explorer](../src/plugins/data_explorer/README.md)
+      - [Data_source](../src/plugins/data_source/README.md)
+      - [Data_source_management](../src/plugins/data_source_management/README.md)
+      - [Dev_tools](../src/plugins/dev_tools/README.md)
+      - [Discover](../src/plugins/discover/README.md)
+      - [Embeddable](../src/plugins/embeddable/README.md)
+      - [Expressions](../src/plugins/expressions/README.md)
+      - [Home](../src/plugins/home/README.md)
+      - index_pattern_management
+        - public
+          - components
+            - create_index_pattern_wizard
+              - [CREATE_INDEX_PATTERN](../src/plugins/index_pattern_management/public/components/create_index_pattern_wizard/CREATE_INDEX_PATTERN.md)
+      - [Input_control_vis](../src/plugins/input_control_vis/README.md)
+      - [Inspector](../src/plugins/inspector/README.md)
+      - [Navigation](../src/plugins/navigation/README.md)
+      - [Opensearch_dashboards_legacy](../src/plugins/opensearch_dashboards_legacy/README.md)
+      - [Opensearch_dashboards_overview](../src/plugins/opensearch_dashboards_overview/README.md)
+      - [Opensearch_dashboards_react](../src/plugins/opensearch_dashboards_react/README.md)
+      - [Opensearch_dashboards_usage_collection](../src/plugins/opensearch_dashboards_usage_collection/README.md)
+      - [Opensearch_dashboards_utils](../src/plugins/opensearch_dashboards_utils/README.md)
+      - opensearch_ui_shared
+        - public
+          - forms
+            - [Form_wizard](../src/plugins/opensearch_ui_shared/public/forms/form_wizard/README.md)
+            - [Multi_content](../src/plugins/opensearch_ui_shared/public/forms/multi_content/README.md)
+      - [Saved_objects](../src/plugins/saved_objects/README.md)
+      - [Saved_objects_management](../src/plugins/saved_objects_management/README.md)
+      - [Share](../src/plugins/share/README.md)
+      - [Telemetry](../src/plugins/telemetry/README.md)
+      - [Telemetry_collection_manager](../src/plugins/telemetry_collection_manager/README.md)
+      - [Telemetry_management_section](../src/plugins/telemetry_management_section/README.md)
+      - [Ui_actions](../src/plugins/ui_actions/README.md)
+      - [Url_forwarding](../src/plugins/url_forwarding/README.md)
+      - [Usage_collection](../src/plugins/usage_collection/README.md)
+      - [Vis_augmenter](../src/plugins/vis_augmenter/README.md)
+      - [Vis_builder](../src/plugins/vis_builder/README.md)
+      - [Vis_default_editor](../src/plugins/vis_default_editor/README.md)
+      - [Vis_type_markdown](../src/plugins/vis_type_markdown/README.md)
+      - [Vis_type_metric](../src/plugins/vis_type_metric/README.md)
+      - [Vis_type_table](../src/plugins/vis_type_table/README.md)
+      - [Vis_type_tagcloud](../src/plugins/vis_type_tagcloud/README.md)
+      - [Vis_type_timeline](../src/plugins/vis_type_timeline/README.md)
+      - [Vis_type_timeseries](../src/plugins/vis_type_timeseries/README.md)
+      - [Vis_type_vega](../src/plugins/vis_type_vega/README.md)
+      - [Vis_type_vislib](../src/plugins/vis_type_vislib/README.md)
+      - [Vis_type_xy](../src/plugins/vis_type_xy/README.md)
+      - [Visualizations](../src/plugins/visualizations/README.md)
+      - [Visualize](../src/plugins/visualize/README.md)
+  - examples
+    - [Dashboard_embeddable_examples](../examples/dashboard_embeddable_examples/README.md)
+    - [Developer_examples](../examples/developer_examples/README.md)
+    - embeddable_examples
+      - public
+        - [Todo](../examples/embeddable_examples/public/todo/README.md)
+    - [Expressions_example](../examples/expressions_example/README.md)
+    - [Routing_example](../examples/routing_example/README.md)
+    - [Search_examples](../examples/search_examples/README.md)
+    - [Ui_action_examples](../examples/ui_action_examples/README.md)
+    - [Ui_actions_explorer](../examples/ui_actions_explorer/README.md)
+    - [Url_generators_examples](../examples/url_generators_examples/README.md)
+    - [Url_generators_explorer](../examples/url_generators_explorer/README.md)
+  - packages
+    - [Opensearch datemath](../packages/opensearch-datemath/readme.md)
+    - [Opensearch eslint config opensearch dashboards](../packages/opensearch-eslint-config-opensearch-dashboards/README.md)
+    - [Opensearch safer lodash set](../packages/opensearch-safer-lodash-set/README.md)
+    - [Osd ace](../packages/osd-ace/README.md)
+    - [Osd apm config loader](../packages/osd-apm-config-loader/README.md)
+    - [Osd babel preset](../packages/osd-babel-preset/README.md)
+    - [Osd config](../packages/osd-config/README.md)
+    - [Osd config schema](../packages/osd-config-schema/README.md)
+    - [Osd cross platform](../packages/osd-cross-platform/README.md)
+    - [Osd dev utils](../packages/osd-dev-utils/README.md)
+    - [Osd eslint import resolver opensearch dashboards](../packages/osd-eslint-import-resolver-opensearch-dashboards/README.md)
+    - [Osd eslint plugin eslint](../packages/osd-eslint-plugin-eslint/README.md)
+    - [Osd expect](../packages/osd-expect/README.md)
+    - [Osd i18n](../packages/osd-i18n/README.md)
+    - [Osd logging](../packages/osd-logging/README.md)
+    - [Osd monaco](../packages/osd-monaco/README.md)
+    - [Osd opensearch](../packages/osd-opensearch/README.md)
+    - [Osd optimizer](../packages/osd-optimizer/README.md)
+    - [Osd plugin generator](../packages/osd-plugin-generator/README.md)
+    - [Osd plugin helpers](../packages/osd-plugin-helpers/README.md)
+    - [Osd pm](../packages/osd-pm/README.md)
+    - [Osd spec to console](../packages/osd-spec-to-console/README.md)
+    - [Osd std](../packages/osd-std/README.md)
+    - [Osd stylelint config](../packages/osd-stylelint-config/README.md)
+    - [Osd stylelint plugin stylelint](../packages/osd-stylelint-plugin-stylelint/README.md)
+    - [Osd telemetry tools](../packages/osd-telemetry-tools/README.md)
+    - [Osd test](../packages/osd-test/README.md)
+    - [Osd test subj selector](../packages/osd-test-subj-selector/README.md)
+    - [Osd ui framework](../packages/osd-ui-framework/README.md)
+    - [Osd ui shared deps](../packages/osd-ui-shared-deps/README.md)
+    - [Osd utility types](../packages/osd-utility-types/README.md)
+    - [Osd utils](../packages/osd-utils/README.md)
+    - [README](../packages/README.md)
+  - release-notes
+    - [Opensearch dashboards.release notes 1.0.0 rc1](../release-notes/opensearch-dashboards.release-notes-1.0.0-rc1.md)
+    - [Opensearch dashboards.release notes 1.0.0](../release-notes/opensearch-dashboards.release-notes-1.0.0.md)
+    - [Opensearch dashboards.release notes 1.1.0](../release-notes/opensearch-dashboards.release-notes-1.1.0.md)
+    - [Opensearch dashboards.release notes 1.2.0](../release-notes/opensearch-dashboards.release-notes-1.2.0.md)
+    - [Opensearch dashboards.release notes 1.3.0](../release-notes/opensearch-dashboards.release-notes-1.3.0.md)
+    - [Opensearch dashboards.release notes 1.3.1](../release-notes/opensearch-dashboards.release-notes-1.3.1.md)
+    - [Opensearch dashboards.release notes 1.3.10](../release-notes/opensearch-dashboards.release-notes-1.3.10.md)
+    - [Opensearch dashboards.release notes 1.3.11](../release-notes/opensearch-dashboards.release-notes-1.3.11.md)
+    - [Opensearch dashboards.release notes 1.3.12](../release-notes/opensearch-dashboards.release-notes-1.3.12.md)
+    - [Opensearch dashboards.release notes 1.3.13](../release-notes/opensearch-dashboards.release-notes-1.3.13.md)
+    - [Opensearch dashboards.release notes 1.3.14](../release-notes/opensearch-dashboards.release-notes-1.3.14.md)
+    - [Opensearch dashboards.release notes 1.3.2](../release-notes/opensearch-dashboards.release-notes-1.3.2.md)
+    - [Opensearch dashboards.release notes 1.3.3](../release-notes/opensearch-dashboards.release-notes-1.3.3.md)
+    - [Opensearch dashboards.release notes 1.3.5](../release-notes/opensearch-dashboards.release-notes-1.3.5.md)
+    - [Opensearch dashboards.release notes 1.3.6](../release-notes/opensearch-dashboards.release-notes-1.3.6.md)
+    - [Opensearch dashboards.release notes 1.3.7](../release-notes/opensearch-dashboards.release-notes-1.3.7.md)
+    - [Opensearch dashboards.release notes 1.3.8](../release-notes/opensearch-dashboards.release-notes-1.3.8.md)
+    - [Opensearch dashboards.release notes 1.3.9](../release-notes/opensearch-dashboards.release-notes-1.3.9.md)
+    - [Opensearch dashboards.release notes 2.0.0 rc1](../release-notes/opensearch-dashboards.release-notes-2.0.0-rc1.md)
+    - [Opensearch dashboards.release notes 2.0.0](../release-notes/opensearch-dashboards.release-notes-2.0.0.md)
+    - [Opensearch dashboards.release notes 2.0.1](../release-notes/opensearch-dashboards.release-notes-2.0.1.md)
+    - [Opensearch dashboards.release notes 2.1.0](../release-notes/opensearch-dashboards.release-notes-2.1.0.md)
+    - [Opensearch dashboards.release notes 2.10.0](../release-notes/opensearch-dashboards.release-notes-2.10.0.md)
+    - [Opensearch dashboards.release notes 2.11.0](../release-notes/opensearch-dashboards.release-notes-2.11.0.md)
+    - [Opensearch dashboards.release notes 2.11.1](../release-notes/opensearch-dashboards.release-notes-2.11.1.md)
+    - [Opensearch dashboards.release notes 2.12.0](../release-notes/opensearch-dashboards.release-notes-2.12.0.md)
+    - [Opensearch dashboards.release notes 2.2.0](../release-notes/opensearch-dashboards.release-notes-2.2.0.md)
+    - [Opensearch dashboards.release notes 2.2.1](../release-notes/opensearch-dashboards.release-notes-2.2.1.md)
+    - [Opensearch dashboards.release notes 2.3.0](../release-notes/opensearch-dashboards.release-notes-2.3.0.md)
+    - [Opensearch dashboards.release notes 2.4.0](../release-notes/opensearch-dashboards.release-notes-2.4.0.md)
+    - [Opensearch dashboards.release notes 2.4.1](../release-notes/opensearch-dashboards.release-notes-2.4.1.md)
+    - [Opensearch dashboards.release notes 2.5.0](../release-notes/opensearch-dashboards.release-notes-2.5.0.md)
+    - [Opensearch dashboards.release notes 2.6.0](../release-notes/opensearch-dashboards.release-notes-2.6.0.md)
+    - [Opensearch dashboards.release notes 2.7.0](../release-notes/opensearch-dashboards.release-notes-2.7.0.md)
+    - [Opensearch dashboards.release notes 2.8.0](../release-notes/opensearch-dashboards.release-notes-2.8.0.md)
+    - [Opensearch dashboards.release notes 2.9.0](../release-notes/opensearch-dashboards.release-notes-2.9.0.md)
+  - scripts
+    - [README](../scripts/README.md)
+  - [DOCS_README](DOCS_README.md)
+  - [CHANGELOG](../CHANGELOG.md)
+  - [CODE_OF_CONDUCT](../CODE_OF_CONDUCT.md)
+  - [COMMUNICATIONS](../COMMUNICATIONS.md)
+  - [CONTRIBUTING](../CONTRIBUTING.md)
+  - [DEVELOPER_GUIDE](../DEVELOPER_GUIDE.md)
+  - [MAINTAINERS](../MAINTAINERS.md)
+  - [README](../README.md)
+  - [RELEASING](../RELEASING.md)
+  - [SECURITY](../SECURITY.md)
+  - [TESTING](../TESTING.md)
+  - [TYPESCRIPT](../TYPESCRIPT.md)
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" title="light" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
+  <link rel="stylesheet" title="dark" href="//cdn.jsdelivr.net/npm/docsify/themes/dark.css">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-dark-switch/dist/docsify-dark-switch.css">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/sidebar-folder.min.css" />
+</head>
+<body>
+  <div id="app"></div>
+  <!-- <script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script> -->
+
+  <script>
+    window.$docsify = {
+      name: 'OpenSearch Dashboards Developer docs',
+      repo: 'opensearch-project/OpenSearch-Dashboards',
+      loadSidebar: true,
+      autoHeader: true,
+      auto2top: true,
+      subMaxLevel: 3,
+      '/.*/_sidebar.md': '/_sidebar.md',
+      sidebarDisplayLevel: 1, // set sidebar display level
+      alias: {
+        '/': './DOCS_README.md',
+        '/.*/_sidebar.md': '/_sidebar.md', // See #301
+      },
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-dark-switch/dist/docsify-dark-switch.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"></script>
+</body>
+</html>
diff --git a/index.html b/index.html
@@ -0,0 +1,13 @@
+<!-- Redirect for docsify so that server can start on the root folder -->
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Redirecting...</title>
+    <script>
+        window.location.href = "./docs/index.html";
+    </script>
+</head>
+<body>
+    <p>If you are not redirected, <a href="./docs/index.html">click here to view the documentation</a>.</p>
+</body>
+</html>
diff --git a/package.json b/package.json
@@ -75,6 +75,7 @@
     "osd:watch": "scripts/use_node scripts/opensearch_dashboards --dev --logging.json=false",
     "build:types": "scripts/use_node scripts/remove.js ./target/types && tsc --p tsconfig.types.json",
     "docs:acceptApiChanges": "scripts/use_node --max-old-space-size=6144 scripts/check_published_api_changes.js --accept",
+    "docs:generateDevDocs": "scripts/use_node scripts/generate_docs_sidebar.js",
     "osd:bootstrap": "scripts/use_node scripts/build_ts_refs && scripts/use_node scripts/register_git_hook",
     "spec_to_console": "scripts/use_node scripts/spec_to_console",
     "pkg-version": "scripts/use_node -e \"console.log(require('./package.json').version)\"",