Skip to content

Commit e72327f

Browse files
committed
Drop all docs except reference. Add deprecation notice.
1 parent 7ae550e commit e72327f

21 files changed

+29
-1847
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
databroker/_version.py export-subst
22
.git_archival.txt export-subst
3+
# SCM syntax highlighting & preventing 3-way merges
4+
pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,6 @@ data/*
141141

142142
# version file generated by setuptools
143143
*_version.py
144+
# pixi environments
145+
.pixi/*
146+
!.pixi/config.toml

README.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,24 @@ Databroker
44

55
|build_status| |coverage| |pypi_version| |license|
66

7-
**The Databroker project is now in maintenance mode, and it is not recommended
8-
for new users. It will be maintained until for years to come to support
9-
existing user code. New users should use Bluesky Tiled Plugins.**
7+
Deprecation Notice
8+
==================
9+
10+
Databroker is no longer recommended for new users or facilities adopting
11+
Bluesky. Instead, `Tiled`_ with `Bluesky Tiled Plugins`_ is recommended as the
12+
canonical way to persist and access data and metadata from Bluesky.
13+
14+
Databroker now serves two purposes that remain relevant for some users and some
15+
faciilities. First, it contains code adapting the legacy MongoDB-based Bluesky
16+
document storage to Tiled---effectively a server-side plugin for Tiled. Second,
17+
it wraps the Tiled Python client to provide an API backward-compatible with
18+
legacy Databroker user code. _If you do not have MongoDB-based Bluesky storage
19+
and you do not have legacy Databroker user code, you do not need Databroker._
20+
21+
Databroker will be maintained by NSLS-II through **April 2027** at minimum to
22+
support the transition from MongoDB-based document storage to PostgreSQL-based
23+
storage. The Python user interface may be maintained longer still, depending on
24+
the need.
1025

1126
============== ==============================================================
1227
PyPI ``pip install databroker``
@@ -93,3 +108,7 @@ See the tutorials for more.
93108
.. _Suitcase: https://blueskyproject.io/suitcase/
94109

95110
.. _Intake: https://intake.readthedocs.io/en/latest/
111+
112+
.. _Bluesky Tiled Plugins: https://blueskyproject.io/bluesky-tiled-plugins/
113+
114+
.. _Tiled: https://blueskyproject.io/tiled/

databroker/tutorial_utils.py

Lines changed: 0 additions & 95 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646
'sphinx.ext.mathjax',
4747
'sphinx.ext.viewcode',
4848
'sphinx.ext.autosummary',
49-
'sphinx.ext.extlinks',
5049
'numpydoc',
5150
'IPython.sphinxext.ipython_directive',
5251
'IPython.sphinxext.ipython_console_highlighting',

docs/source/explanations/local-and-remote-use-cases.rst

Lines changed: 0 additions & 107 deletions
This file was deleted.

docs/source/explanations/relationship-to-intake.rst

Lines changed: 0 additions & 98 deletions
This file was deleted.

0 commit comments

Comments
 (0)