Skip to content

Commit

Permalink
chore: polish readme to fix dead links
Browse files Browse the repository at this point in the history
Signed-off-by: lizhanhui <lizhanhui@gmail.com>
  • Loading branch information
lizhanhui committed Nov 14, 2023
1 parent fcfe8aa commit e58c4b9
Show file tree
Hide file tree
Showing 7 changed files with 2 additions and 47 deletions.
1 change: 0 additions & 1 deletion LICENSE.txt

This file was deleted.

10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
# Elastic Stream

[![Codecov](https://img.shields.io/codecov/c/gh/AutoMQ/elastic-stream/master)](https://app.codecov.io/gh/AutoMQ/elastic-stream)

## Overview
ElasticStream is an open-source, elastic streaming platform. ElasticStream is designed on top of cloud infra-structure, excelling itself in scalability, fault-tolerance, cost-effectiveness and security.

![Overview](docs/images/elastic-stream-arc.png)


## Getting Started
If you are brand new to elastic stream, we recommend you checkout our [motivation and architecture](https://elastic-stream.automq.com/docs/category/architecture) first. In case you want to get the system up and run quick demos, please read the [quick-start guide](https://elastic-stream.automq.com/docs/quick-start).
If you are brand new to elastic stream, we recommend you checkout our [motivation and architecture](docs/architecture) first. In case you want to get the system up and run quick demos, please read the [quick-start guide](docs/quick-start).

## Documentation

Various docs and guides are placed [here](https://elastic-stream.automq.com).
Various docs and guides are placed [here](docs).

## How to Contribute
We welcome contribution of various types: documentation, bug reporting, feature request, and pull requests. Before proposing a major large-scale change, it is advised to discuss your proposal first.


## License
This project is licensed under the [Server Side Public License](https://spdx.org/licenses/SSPL-1.0.html)
4 changes: 0 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
draft: true
---

# Table of Contents

* [Quick Start](./quick-start.mdx)
Expand Down
8 changes: 0 additions & 8 deletions docs/architecture/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/observability/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/tlaplus/_category_.json

This file was deleted.

10 changes: 0 additions & 10 deletions vercel.json

This file was deleted.

0 comments on commit e58c4b9

Please sign in to comment.