Skip to content

Commit

Permalink
Remove docs directory and update README (#2127)
Browse files Browse the repository at this point in the history
  • Loading branch information
brfrn169 authored Jul 31, 2024
1 parent 2089188 commit 562f380
Show file tree
Hide file tree
Showing 49 changed files with 7 additions and 7,503 deletions.
46 changes: 0 additions & 46 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -112,52 +112,6 @@ jobs:
with:
arguments: ':schema-loader:dockerfileLint'

build-check-example-project:
name: Build check for 'Getting Started' example project
runs-on: ubuntu-latest

defaults:
run:
working-directory: docs/getting-started

steps:
- uses: actions/checkout@v4

- name: Set up JDK ${{ env.JAVA_VERSION }} (${{ env.JAVA_VENDOR }})
uses: actions/setup-java@v4
with:
java-version: ${{ env.JAVA_VERSION }}
distribution: ${{ env.JAVA_VENDOR }}

- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3

- name: Build Getting Started project
run: ./gradlew assemble

build-check-example-project-for-kotlin:
name: Build check for 'Getting Started' example project for Kotlin
runs-on: ubuntu-latest

defaults:
run:
working-directory: docs/getting-started-kotlin

steps:
- uses: actions/checkout@v4

- name: Set up JDK ${{ env.JAVA_VERSION }} (${{ env.JAVA_VENDOR }})
uses: actions/setup-java@v4
with:
java-version: ${{ env.JAVA_VERSION }}
distribution: ${{ env.JAVA_VENDOR }}

- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3

- name: Build Getting Started project
run: ./gradlew assemble

integration-test-for-cassandra-3-0:
name: Cassandra 3.0 integration test (${{ matrix.mode.label }})
runs-on: ubuntu-latest
Expand Down
39 changes: 7 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# ScalarDB

ScalarDB is a universal transaction manager that achieves:
- database/storage-agnostic ACID transactions in a scalable manner even if an underlying database or storage is not ACID-compliant.
- multi-storage/database/service ACID transactions that can span multiple (possibly different) databases, storages, and services.
ScalarDB is a cross-database HTAP engine. It achieves ACID transactions and real-time analytics across diverse databases to simplify the complexity of managing multiple databases.

## Install

The library is available on [maven central repository](https://mvnrepository.com/artifact/com.scalar-labs/scalardb).
You can install it in your application using your build tool such as Gradle and Maven.

Expand All @@ -26,35 +25,10 @@ To add a dependency using Maven:

## Docs

* [ScalarDB Documentation](https://scalardb.scalar-labs.com/docs/latest/)
* [ScalarDB Overview](https://scalardb.scalar-labs.com/docs/latest/overview)
* [ScalarDB Design Document](https://scalardb.scalar-labs.com/docs/latest/design/)
* [Getting Started with ScalarDB](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb/)
* [Getting Started with ScalarDB by Using Kotlin](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb-by-using-kotlin/)
* [Add ScalarDB to Your Build](https://scalardb.scalar-labs.com/docs/latest/add-scalardb-to-your-build/)
* [ScalarDB Java API Guide](https://scalardb.scalar-labs.com/docs/latest/api-guide/)
* [Multi-Storage Transactions](https://scalardb.scalar-labs.com/docs/latest/multi-storage-transactions/)
* [Transactions with a Two-Phase Commit Interface](https://scalardb.scalar-labs.com/docs/latest/two-phase-commit-transactions/)
* [ScalarDB Schema Loader](https://scalardb.scalar-labs.com/docs/latest/schema-loader/)
* [Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader](https://scalardb.scalar-labs.com/docs/latest/schema-loader-import/)
* [Requirements and Recommendations for the Underlying Databases of ScalarDB](https://scalardb.scalar-labs.com/docs/latest/requirements/)
* [How to Back Up and Restore Databases Used Through ScalarDB](https://scalardb.scalar-labs.com/docs/latest/backup-restore/)
* [ScalarDB Supported Databases](https://scalardb.scalar-labs.com/docs/latest/scalardb-supported-databases/)
* [ScalarDB Configurations](https://scalardb.scalar-labs.com/docs/latest/configurations/)
* [Storage Abstraction and API Guide](https://scalardb.scalar-labs.com/docs/latest/storage-abstraction/)
* [ScalarDB Error Codes](https://scalardb.scalar-labs.com/docs/latest/scalardb-core-status-codes/)
* Slides
* [Making Cassandra more capable, faster, and more reliable](https://speakerdeck.com/scalar/making-cassandra-more-capable-faster-and-more-reliable-at-apachecon-at-home-2020) at ApacheCon@Home 2020
* [Scalar DB: A library that makes non-ACID databases ACID-compliant](https://speakerdeck.com/scalar/scalar-db-a-library-that-makes-non-acid-databases-acid-compliant) at Database Lounge Tokyo #6 2020
* [Transaction Management on Cassandra](https://speakerdeck.com/scalar/transaction-management-on-cassandra) at Next Generation Cassandra Conference / ApacheCon NA 2019
* Javadoc
* [scalardb](https://javadoc.io/doc/com.scalar-labs/scalardb/latest/index.html) - ScalarDB: A universal transaction manager that achieves database-agnostic transactions and distributed transactions that span multiple databases
* [scalardb-rpc](https://javadoc.io/doc/com.scalar-labs/scalardb-rpc/latest/index.html) - ScalarDB RPC libraries
* [scalardb-schema-loader](https://javadoc.io/doc/com.scalar-labs/scalardb-schema-loader/latest/index.html) - ScalarDB Schema Loader: A tool for schema creation and schema deletion in ScalarDB
* [Jepsen tests](https://github.com/scalar-labs/scalar-jepsen)
* [TLA+](tla+/consensus-commit/README.md)
See our [User Documentation](https://scalardb.scalar-labs.com/docs/latest/).

## Contributing

This library is mainly maintained by the Scalar Engineering Team, but of course we appreciate any help.

* For asking questions, finding answers and helping other users, please go to [stackoverflow](https://stackoverflow.com/) and use [scalardb](https://stackoverflow.com/questions/tagged/scalardb) tag.
Expand Down Expand Up @@ -86,7 +60,8 @@ All the exception and log messages in this project are consistent with the follo
When contributing to this project, please follow these guidelines.

## License

ScalarDB is dual-licensed under both the Apache 2.0 License (found in the LICENSE file in the root directory) and a commercial license.
You may select, at your option, one of the above-listed licenses.
The commercial license includes several enterprise-grade features such as ScalarDB Server, management tools, and declarative query interfaces like GraphQL and SQL interfaces.
Regarding the commercial license, please [contact us](https://scalar-labs.com/contact_us/) for more information.
The commercial license includes several enterprise-grade features such as ScalarDB Cluster, management tools, and declarative query interfaces like GraphQL and SQL interfaces.
For more information about the commercial license, please [contact us](https://www.scalar-labs.com/contact).
9 changes: 0 additions & 9 deletions docs/_config.yml

This file was deleted.

11 changes: 0 additions & 11 deletions docs/_includes/analytics.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/_layouts/default.html

This file was deleted.

43 changes: 0 additions & 43 deletions docs/add-scalardb-to-your-build.md

This file was deleted.

Loading

0 comments on commit 562f380

Please sign in to comment.