Skip to content

Commit

Permalink
Fix lychee link checking.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <dblock@dblock.org>
  • Loading branch information
dblock committed Sep 16, 2021
1 parent 1f5a463 commit d9387c4
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- uses: actions/checkout@v2
- name: lychee Link Checker
id: lychee
uses: lycheeverse/lychee-action@master
uses: lycheeverse/lychee-action@v1.0.8
with:
args: --accept=200,403,429 "**/*.html" "**/*.md" "**/*.txt" "**/*.json"
env:
Expand Down
30 changes: 15 additions & 15 deletions INSTALLING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@

### Installing OpenSearch Plugins

Assemble, extract and run OpenSearch `1.0.0-beta1` using [Building OpenSearch package](https://github.com/opensearch-project/OpenSearch/blob/main/TESTING.md#creating-packages).
Assemble, extract and run OpenSearch `1.0.0` using [Building OpenSearch package](https://github.com/opensearch-project/OpenSearch/blob/main/TESTING.md#creating-packages).

_Example_: For Linux platform.

```
~/ > git clone https://github.com/opensearch-project/OpenSearch.git
~/OpenSearch (main)> git checkout 1.0.0-beta1
~/OpenSearch (main)> git checkout 1.0.0
~/OpenSearch (main)> ./gradlew :distribution:archives:linux-tar:assemble -Dbuild.version_qualifier=beta1 -Dbuild.snapshot=false
~/OpenSearch (main)> tar vfxz distribution/archives/linux-tar/build/distributions/opensearch-1.0.0-beta1-linux-x64.tar.gz
~/OpenSearch (main)> cd opensearch-1.0.0-beta1
~/OpenSearch/opensearch-1.0.0-beta1 (main)> ./bin/opensearch
~/OpenSearch (main)> tar vfxz distribution/archives/linux-tar/build/distributions/opensearch-1.0.0-linux-x64.tar.gz
~/OpenSearch (main)> cd opensearch-1.0.0
~/OpenSearch/opensearch-1.0.0 (main)> ./bin/opensearch
```

Checkout, build and install the plugin.
Expand All @@ -27,29 +27,29 @@ To build the plugins with OpenSearch, plugins may require building all their dep

```
~/OpenSearch (main)> git clone https://github.com/opensearch-project/job-scheduler.git
~/OpenSearch/job-scheduler (main)> ./gradlew assemble -Dopensearch.version=1.0.0-beta1 -Dbuild.snapshot=false
~/OpenSearch/job-scheduler (main)> cd build/distributions && cp opensearch-job-scheduler-1.0.0.0-beta1.zip ~/
~/OpenSearch/opensearch-1.0.0-beta1 (main)> ./bin/opensearch-plugin install file:///opensearch-job-scheduler-1.0.0.0-beta1.zip
~/OpenSearch/job-scheduler (main)> ./gradlew assemble -Dopensearch.version=1.0.0 -Dbuild.snapshot=false
~/OpenSearch/job-scheduler (main)> cd build/distributions && cp opensearch-job-scheduler-1.0.0.0.zip ~/
~/OpenSearch/opensearch-1.0.0 (main)> ./bin/opensearch-plugin install file:///opensearch-job-scheduler-1.0.0.0.zip
~/OpenSearch (main)> git clone https://github.com/opensearch-project/anomaly-detection.git
~/OpenSearch/anomaly-detection (main)> ./gradlew assemble -Dopensearch.version=1.0.0-beta1 -Dbuild.snapshot=false
~/OpenSearch/anomaly-detection (main)> cd build/distributions && cp opensearch-anomaly-detection-1.0.0.0-beta1.zip ~/
~/OpenSearch/opensearch-1.0.0-beta1 (main)> ./bin/opensearch-plugin install file:///opensearch-anomaly-detection-1.0.0.0-beta1.zip
~/OpenSearch/anomaly-detection (main)> ./gradlew assemble -Dopensearch.version=1.0.0 -Dbuild.snapshot=false
~/OpenSearch/anomaly-detection (main)> cd build/distributions && cp opensearch-anomaly-detection-1.0.0.0.zip ~/
~/OpenSearch/opensearch-1.0.0 (main)> ./bin/opensearch-plugin install file:///opensearch-anomaly-detection-1.0.0.0.zip
```

Install the plugins in order if they are dependent on other plugins.

### Installing OpenSearch Dashboards Plugins

Build and run OpenSearch Dashboards `1.0.0-beta1`. For setting up `yarn` and `nvm` follow instructions [Getting Started](https://github.com/opensearch-project/OpenSearch-Dashboards#getting-started).
Build and run OpenSearch Dashboards `1.0.0`. For setting up `yarn` and `nvm` follow instructions [Getting Started](https://github.com/opensearch-project/OpenSearch-Dashboards#getting-started).

_Example_: For Linux platform.

```
~/ > git clone https://github.com/opensearch-project/OpenSearch-Dashboards.git
~/OpenSearch-Dashboards (main)> git checkout 1.0.0-beta1
~/OpenSearch-Dashboards (main)> git checkout 1.0.0
~/OpenSearch-Dashboards (main)> yarn build --release --version-qualifier beta1
~/OpenSearch-Dashboards (main)> cd build/opensearch-dashboards-1.0.0-beta1-linux-x64
~/OpenSearch-Dashboards/build/opensearch-dashboards-1.0.0-beta1-linux-x64 (main)> ./bin/opensearch-dashboards
~/OpenSearch-Dashboards (main)> cd build/opensearch-dashboards-1.0.0-linux-x64
~/OpenSearch-Dashboards/build/opensearch-dashboards-1.0.0-linux-x64 (main)> ./bin/opensearch-dashboards
```

Checkout, boostrap and run OpenSearch Dashboards with the plugin.
Expand Down
28 changes: 14 additions & 14 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<!-- TOC -->

- [Upgrading Plugins to OpenSearch and OpenSearch Dashboards](#upgrading-plugins-to-opensearch-and-opensearch-dashboards)
- [Upgrading to OpenSearch](#upgrading-to-opensearch)
- [OpenSearch Plugins](#opensearch-plugins)
- [Building](#building)
- [Naming Conventions](#naming-conventions)
- [Backwards Compatibility](#backwards-compatibility)
- [Settings](#settings)
- [Rest APIs on 9200](#rest-apis-on-9200-port)
- [Rest APIs on 9600 or other ports](#rest-apis-on-9600-or-other-ports)
- [Indices](#indices)
- [OpenSearch Dashboards Plugins](#opensearch-dashboards-plugins)
- [Building](#building)
- [Naming Conventions](#naming-conventions)
- [REST API Compatibility with OpenSearch Plugins](#rest-api-compatibility-with-opensearch-plugins)
- [Upgrading to OpenSearch](#upgrading-to-opensearch)
- [OpenSearch Plugins](#opensearch-plugins)
- [Building](#building)
- [Naming Conventions](#naming-conventions)
- [Backwards Compatibility](#backwards-compatibility)
- [Settings](#settings)
- [Rest APIs on 9200 port](#rest-apis-on-9200-port)
- [Rest APIs on 9600 or other ports](#rest-apis-on-9600-or-other-ports)
- [Indices](#indices)
- [OpenSearch Dashboards Plugins](#opensearch-dashboards-plugins)
- [Building](#building-1)
- [Naming Conventions](#naming-conventions-1)
- [REST API Compatibility with OpenSearch Plugins](#rest-api-compatibility-with-opensearch-plugins)

<!-- /TOC -->

Expand Down Expand Up @@ -279,7 +279,7 @@ Do not change index names at this time to preserve backwards compatibility.
3. Create a `plugins` directory in the root of the project, if it doesn't exist.
4. Run `yarn osd bootstrap` inside `opensearch-dashboards/plugins/opensearch-dashboards-plugin`.
5. Build and test your plugin.
6. Report all runtime failures of OpenSearch Dashboards to [OpenSearch Dashboards Issues](http://github.com/opensearch-project/opensearch-dashboards/issues) and runtime failures of plugins in plugin repositories.
6. Report all runtime failures of OpenSearch Dashboards to [OpenSearch Dashboards Issues](https://github.com/opensearch-project/opensearch-dashboards/issues) and runtime failures of plugins in plugin repositories.

#### Naming Conventions

Expand Down

0 comments on commit d9387c4

Please sign in to comment.