Skip to content

Create STATUS.md, give insight in feature stability #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)**
Expand Down
32 changes: 32 additions & 0 deletions server/STATUS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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.
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.

- 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.