Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and more GitHub pages setup #869

Merged
merged 2 commits into from
Jul 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
* [Maintainers](#maintainers)
* [Code of Conduct](#code-of-conduct)

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/).

## Introduction
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.

Expand Down
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ title: OpenSearch SDK for Java
description: Extension Documentation
theme: jekyll-theme-minimal
logo: /assets/img/logo.png
include: CONTRIBUTING.md

sidenav:
- name: Design
Expand Down
2 changes: 1 addition & 1 deletion _includes/head_custom.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
<!-- {% include head-custom-google-analytics.html %} -->

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

<!-- end custom head snippets -->
Binary file added assets/img/favicon.ico
Binary file not shown.
Loading