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

Issue 238: Convert markdown to support Docusaurus and combined docs repo #239

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
4 changes: 2 additions & 2 deletions documentation/src/docs/installation-guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installation Guide
<!--
Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.

Expand All @@ -8,8 +9,7 @@ You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
-->


Prepare your environment
## Prepare your environment
Schema Registry uses Pravega to store the schemas durably. Following steps assumes you have pravega deployed and running.

### Helm Chart
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Overview
<!--
Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.

Expand All @@ -7,7 +8,6 @@ You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
-->
# Schema Registry Overview

Pravega Schema Registry is the latest service offering from Pravega family. The registry service is designed to store and manage schemas for the unstructured data stored in Pravega streams. The service is designed to not be limited to the data stored in Pravega and can serve as a general purpose management solution for storing and evolving schemas in wide variety of streaming and non streaming use cases.

Expand Down
4 changes: 1 addition & 3 deletions documentation/src/docs/rest-documentation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# REST API Documentation
<!--
Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.

Expand All @@ -8,9 +9,6 @@ You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
-->

# Pravega Schema Registry APIs
REST APIs for Pravega Schema Registry.

## Version: 0.0.1

**License:** [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Expand Down
2 changes: 2 additions & 0 deletions documentation/src/docs/rest-usage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# REST API Usage
<!--
Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.

Expand All @@ -7,6 +8,7 @@ You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
-->

## REST API Sample curl commands
Schema Registry Service provides a RESTful interface for storing and managing schemas under schema groups. Users create a named schema group under which they store and evolve the schemas according to desired compatibility policy.

Expand Down
1 change: 1 addition & 0 deletions documentation/src/docs/schema-registry-concepts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Concepts
<!--
Copyright (c) Dell Inc., or its subsidiaries. All Rights Reserved.

Expand Down
13 changes: 13 additions & 0 deletions documentation/src/docs/sidebars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module.exports = {
mainSidebar: [
'overview',
'schema-registry-concepts',
{
'Using Schema Registry SDK': [
'rest-usage',
'rest-documentation',
]
},
'installation-guide',
]
};