Skip to content

Commit a898727

Browse files
authored
Update readme and more GitHub pages setup (#869)
* Update readme with the published website link and more GitHub pages setup Signed-off-by: Fanit Kolchina <[email protected]> * Move favicon to assets Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]>
1 parent 936b840 commit a898727

File tree

4 files changed

+4
-1
lines changed

4 files changed

+4
-1
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
* [Maintainers](#maintainers)
1515
* [Code of Conduct](#code-of-conduct)
1616

17+
To view extension documentation as a webpage, go to [https://opensearch-project.github.io/opensearch-sdk-java/](https://opensearch-project.github.io/opensearch-sdk-java/).
18+
1719
## Introduction
1820
With OpenSearch plugins, you can extend and enhance various core features. However, the current plugin architecture may fatally impact clusters in the event of failure. To ensure that plugins run safely without impacting the system, our goal is to isolate plugin interactions with OpenSearch. The OpenSearch SDK for Java modularizes the [extension points](https://opensearch.org/blog/technical-post/2021/12/plugins-intro/) onto which plugins hook.
1921

_config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ title: OpenSearch SDK for Java
22
description: Extension Documentation
33
theme: jekyll-theme-minimal
44
logo: /assets/img/logo.png
5+
include: CONTRIBUTING.md
56

67
sidenav:
78
- name: Design

_includes/head_custom.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
<!-- {% include head-custom-google-analytics.html %} -->
55

66
<!-- You can set your favicon here -->
7-
<link rel="shortcut icon" type="image/ico" href="{{ /assets/img/logo.png | relative_url }}" >
7+
<link rel="shortcut icon" type="image/ico" href="{{ /assets/img/favicon.ico | relative_url }}" >
88

99
<!-- end custom head snippets -->

assets/img/favicon.ico

3.23 KB
Binary file not shown.

0 commit comments

Comments
 (0)