From 512f0b43b51d9f4d6853e79294d4608cdc6f8380 Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Tue, 10 Jan 2023 10:08:12 +0100 Subject: [PATCH 1/3] Create STATUS.md --- server/STATUS.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 server/STATUS.md diff --git a/server/STATUS.md b/server/STATUS.md new file mode 100644 index 000000000..3c285b473 --- /dev/null +++ b/server/STATUS.md @@ -0,0 +1,31 @@ +# Atomic-Server status & Feature stability + +If you're contemplating to use Atomic-Server in a prodcution environment, you'll want to know to what extend you could rely on this project. +Some features are prone to change, whilst others are already fully working as intended. +This document describes the current status of Atomic-Server, and specifically which features are stable, and which are not. + +## Stable + +These features are very unlikely to be significantly altered until V1.0. They will also not be dropped. + +- HTTP Resource fetching. +- JSON-AD serialization / parsing. +- TLS / HTTPS setup. +- WebSockets. Some features may be added, but for most use cases the current implementation works great. +- Commits. There may be changes in the signature algorithm or the likes, but I don't expect much changes. +- Storage + migration system. Upgrading your Atomic-Server should not lead to data loss. Migrations are fully automated. + +## Likely to change + +- Endpoint API. Currently only supports GET requests. +- Collections / Queries. Relatively stable, but still lacks some important features (like having multiple filters in one Query). +- Cookie Authentication. +- Document editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/2). +- Table editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/3). +- URL requirements for new URLS, see [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/556) +- Full text search. Improvements to sorting algorithm and adding more filter options is likely. + +## Experimental + +- Plugin system. All APIs related to this are very likely to change. See [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/73) +- Chat rooms. They work, but expect serious changes. From ea77ce365a4b96103d745a738358f2894f2af9d7 Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Tue, 10 Jan 2023 19:31:31 +0100 Subject: [PATCH 2/3] Update server/STATUS.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Florian Häglsperger --- server/STATUS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server/STATUS.md b/server/STATUS.md index 3c285b473..997dcdcec 100644 --- a/server/STATUS.md +++ b/server/STATUS.md @@ -1,6 +1,6 @@ # Atomic-Server status & Feature stability -If you're contemplating to use Atomic-Server in a prodcution environment, you'll want to know to what extend you could rely on this project. +If you're contemplating to use Atomic-Server in a production environment, you'll want to know to what extent you could rely on this project. Some features are prone to change, whilst others are already fully working as intended. This document describes the current status of Atomic-Server, and specifically which features are stable, and which are not. From dd961ebf77b4d55c78774197a647e8d9df8b017c Mon Sep 17 00:00:00 2001 From: Joep Meindertsma Date: Tue, 10 Jan 2023 18:38:02 +0000 Subject: [PATCH 3/3] Status links #555 --- CHANGELOG.md | 1 + README.md | 3 ++- server/STATUS.md | 11 ++++++----- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff076c192..08fbd4a13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ List of changes for this repo, including `atomic-cli`, `atomic-server` and `atomic-lib`. By far most changes relate to `atomic-server`, so if not specified, assume the changes are relevant only for the server. Changes to JS assets are not included here, but in [`atomic-data-browser`'s CHANGELOG](https://github.com/atomicdata-dev/atomic-data-browser/blob/main/CHANGELOG.md). +See [STATUS.md](server/STATUS.md) to learn more about which features will remain stable. ## UNRELEASED diff --git a/README.md b/README.md index 71de9f95c..b24ddb1a2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ This repo consists of three components: A library, a server and a CLI.** [![crates.io](https://img.shields.io/crates/v/atomic-server)](https://crates.io/crates/atomic-server) -_Status: Beta. [Breaking changes](CHANGELOG.md) are expected until 1.0._ +_Status: Beta. [Status](server/STATUS.md) specifies which features are stable. [Breaking changes](CHANGELOG.md) are expected until 1.0._ + **Atomic-server is a graph database server for storing and sharing [Atomic Data](https://docs.atomicdata.dev/). Demo on [atomicdata.dev](https://atomicdata.dev)** diff --git a/server/STATUS.md b/server/STATUS.md index 997dcdcec..9eebb52b0 100644 --- a/server/STATUS.md +++ b/server/STATUS.md @@ -1,25 +1,26 @@ # Atomic-Server status & Feature stability -If you're contemplating to use Atomic-Server in a production environment, you'll want to know to what extent you could rely on this project. +If you're contemplating to use Atomic-Server in a production environment, you'll want to know to what extent you could rely on this project. Some features are prone to change, whilst others are already fully working as intended. +See [Changelog](../CHANGELOG.md) for a historical overview of (breaking) changes. This document describes the current status of Atomic-Server, and specifically which features are stable, and which are not. ## Stable -These features are very unlikely to be significantly altered until V1.0. They will also not be dropped. +These features are very unlikely to be significantly altered until V1.0. They will also not be dropped. - HTTP Resource fetching. - JSON-AD serialization / parsing. -- TLS / HTTPS setup. +- TLS / HTTPS setup. - WebSockets. Some features may be added, but for most use cases the current implementation works great. - Commits. There may be changes in the signature algorithm or the likes, but I don't expect much changes. - Storage + migration system. Upgrading your Atomic-Server should not lead to data loss. Migrations are fully automated. ## Likely to change -- Endpoint API. Currently only supports GET requests. +- Endpoint API. Currently only supports GET requests. - Collections / Queries. Relatively stable, but still lacks some important features (like having multiple filters in one Query). -- Cookie Authentication. +- Cookie Authentication. - Document editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/2). - Table editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/3). - URL requirements for new URLS, see [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/556)