Skip to content

Commit 5cc728a

Browse files
committed
Status links #555
1 parent 45bae5c commit 5cc728a

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
List of changes for this repo, including `atomic-cli`, `atomic-server` and `atomic-lib`.
44
By far most changes relate to `atomic-server`, so if not specified, assume the changes are relevant only for the server.
55
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).
6+
See [STATUS.md](server/STATUS.md) to learn more about which features will remain stable.
67

78
## UNRELEASED
89

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ This repo consists of three components: A library, a server and a CLI.**
1111

1212
[![crates.io](https://img.shields.io/crates/v/atomic-server)](https://crates.io/crates/atomic-server)
1313

14-
_Status: Beta. [Breaking changes](CHANGELOG.md) are expected until 1.0._
14+
_Status: Beta. [Status](server/STATUS.md) specifies which features are stable. [Breaking changes](CHANGELOG.md) are expected until 1.0._
15+
1516

1617
**Atomic-server is a graph database server for storing and sharing [Atomic Data](https://docs.atomicdata.dev/).
1718
Demo on [atomicdata.dev](https://atomicdata.dev)**

server/STATUS.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
# Atomic-Server status & Feature stability
22

3-
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.
3+
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.
44
Some features are prone to change, whilst others are already fully working as intended.
5+
See [Changelog](../CHANGELOG.md) for a historical overview of (breaking) changes.
56
This document describes the current status of Atomic-Server, and specifically which features are stable, and which are not.
67

78
## Stable
89

9-
These features are very unlikely to be significantly altered until V1.0. They will also not be dropped.
10+
These features are very unlikely to be significantly altered until V1.0. They will also not be dropped.
1011

1112
- HTTP Resource fetching.
1213
- JSON-AD serialization / parsing.
13-
- TLS / HTTPS setup.
14+
- TLS / HTTPS setup.
1415
- WebSockets. Some features may be added, but for most use cases the current implementation works great.
1516
- Commits. There may be changes in the signature algorithm or the likes, but I don't expect much changes.
1617
- Storage + migration system. Upgrading your Atomic-Server should not lead to data loss. Migrations are fully automated.
1718

1819
## Likely to change
1920

20-
- Endpoint API. Currently only supports GET requests.
21+
- Endpoint API. Currently only supports GET requests.
2122
- Collections / Queries. Relatively stable, but still lacks some important features (like having multiple filters in one Query).
22-
- Cookie Authentication.
23+
- Cookie Authentication.
2324
- Document editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/2).
2425
- Table editor, see [milestone](https://github.com/atomicdata-dev/atomic-data-browser/milestone/3).
2526
- URL requirements for new URLS, see [issue](https://github.com/atomicdata-dev/atomic-data-rust/issues/556)

0 commit comments

Comments
 (0)