[Docs] Creates Developer docs GH page code #5977
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) | ||
|
Comment on lines
+150
to
+153
There was a problem hiding this comment. A little bit weird about the order here. There was a problem hiding this comment. Dont quite know what you mean by the order here. This is simply the folder structure of the OSD repository. What did you expect here? There was a problem hiding this comment. Should be the orders that 2.1.0 -> 2.9.0 and then 2.10.0 I suppose, but for now the order is 2.1.0 -> 2.10.0 -> 2.12.0 -> 2.2.0, not a semantic version order. There was a problem hiding this comment. Ah i see what you mean. Yeah this currently pulls the files as they appear in the filesystem. I could reorder this but I personally liked how they map 1:1 with the file tree :) |
||
| - [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) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: order need to adjust I suppose