diff --git a/documentation/src/docs/installation-guide.md b/documentation/src/docs/installation-guide.md index a7842828..14576481 100644 --- a/documentation/src/docs/installation-guide.md +++ b/documentation/src/docs/installation-guide.md @@ -1,3 +1,4 @@ +# Installation Guide - -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 diff --git a/documentation/src/docs/overview.md b/documentation/src/docs/overview.md index a459a0a7..2dc174b3 100644 --- a/documentation/src/docs/overview.md +++ b/documentation/src/docs/overview.md @@ -1,3 +1,4 @@ +# Overview -# 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. diff --git a/documentation/src/docs/rest-documentation.md b/documentation/src/docs/rest-documentation.md index 9a0757a5..2b4687a1 100644 --- a/documentation/src/docs/rest-documentation.md +++ b/documentation/src/docs/rest-documentation.md @@ -1,3 +1,4 @@ +# REST API Documentation -# 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) diff --git a/documentation/src/docs/rest-usage.md b/documentation/src/docs/rest-usage.md index 4961d103..96992bbe 100644 --- a/documentation/src/docs/rest-usage.md +++ b/documentation/src/docs/rest-usage.md @@ -1,3 +1,4 @@ +# REST API Usage + ## 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. diff --git a/documentation/src/docs/schema-registry-concepts.md b/documentation/src/docs/schema-registry-concepts.md index 5ae0d40d..0afd8ac7 100644 --- a/documentation/src/docs/schema-registry-concepts.md +++ b/documentation/src/docs/schema-registry-concepts.md @@ -1,3 +1,4 @@ +# Concepts