Skip to content

Commit

Permalink
doc: remove Open Source references in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
annastuchlik authored and denesb committed Jan 20, 2025
1 parent 1f20f78 commit e340d6a
Show file tree
Hide file tree
Showing 13 changed files with 36 additions and 47 deletions.
4 changes: 0 additions & 4 deletions docs/alternator/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,10 +216,6 @@ events appear in the Streams API as normal deletions - without the
distinctive marker on deletions which are really expirations.
See <https://github.com/scylladb/scylla/issues/5060>.

<!--- REMOVE IN FUTURE VERSIONS - Remove the note below in version 5.3/2023.1 -->

> **Note** This feature is experimental in versions earlier than ScyllaDB Open Source 5.2 and ScyllaDB Enterprise 2022.2.
## Scan ordering

In DynamoDB, scanning the _entire_ table returns the partitions sorted by
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/install-scylla/install-on-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Install ScyllaDB
sudo apt-get update
sudo apt-get install -y scylla
Running the command installs the latest official version of ScyllaDB Open Source.
Running the command installs the latest official version of ScyllaDB.
To install a specific patch version, list all the available patch versions:

.. code-block:: console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
ScyllaDB Housekeeping and how to disable it
============================================

It is always recommended to run the latest version of ScyllaDB Open Source or ScyllaDB Enterprise.
It is always recommended to run the latest version of ScyllaDB.
The latest stable release version is always available from the `Download Center <https://www.scylladb.com/download/>`_.

When you install ScyllaDB, it installs by default two services: **scylla-housekeeping-restart** and **scylla-housekeeping-daily**. These services check for the latest ScyllaDB version and prompt the user if they are using a version that is older than what is publicly available.
Expand Down
40 changes: 25 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,54 @@
:orphan:

====================================
ScyllaDB Open Source Documentation
ScyllaDB Documentation
====================================

.. meta::
:title: ScyllaDB Open Source Documentation
:description: ScyllaDB Open Source Documentation
:keywords: ScyllaDB Open Source, ScyllaDB Open Source, ScyllaDB docs, ScyllaDB documentation, ScyllaDB Documentation
:title: ScyllaDB Documentation
:description: ScyllaDB Documentation
:keywords: ScyllaDB docs, ScyllaDB documentation, ScyllaDB Documentation

About This User Guide
-----------------------

ScyllaDB is a distributed NoSQL wide-column database for data-intensive apps that require
This user guide covers topics related to ScyllaDB - a distributed NoSQL
wide-column database for data-intensive apps that require
high performance and low latency.

This user guide covers topics related to ScyllaDB Open Source - an open-source project that allows you to evaluate
experimental features, review the `source code <https://github.com/scylladb/scylladb>`_, and add your contributions
to the project.
You can deploy ScyllaDB:

For topics related to other ScyllaDB flavors, see the documentation for `ScyllaDB Enterprise <https://enterprise.docs.scylladb.com/>`_ and
`ScyllaDB Cloud <https://cloud.docs.scylladb.com/>`_.
* On AWS, GCP, and Azure.
* On premises.
* With `ScyllaDB Cloud <https://cloud.scylladb.com/>`_ - a fully managed DBaaS.

This user guide covers topics related to ScyllaDB cloud or on-premises
self-managed deployments.
For details about ScyllaDB Cloud, see the
`ScyllaDB Cloud documentation <https://cloud.docs.scylladb.com/>`_.

Documentation Highlights
--------------------------

* :doc:`Install ScyllaDB Open Source </getting-started/install-scylla/index>`
* :doc:`Configure ScyllaDB Open Source </getting-started/system-configuration/>`
* :doc:`Install ScyllaDB </getting-started/install-scylla/index>`
* :doc:`Configure ScyllaDB </getting-started/system-configuration/>`
* :doc:`Cluster Management Procedures </operating-scylla/procedures/cluster-management/index>`
* :doc:`Upgrade ScyllaDB Open Source </upgrade/index>`
* :doc:`Upgrade ScyllaDB </upgrade/index>`
* :doc:`CQL Reference </cql/index>`
* :doc:`ScyllaDB Drivers </using-scylla/drivers/index>`
* :doc:`Features </features/index>`

ScyllaDB Support
--------------------

ScyllaDB customers can open or check on tickets in the
`ScyllaDB Customer Portal <https://www.scylladb.com/customer-portal/#support>`_.

ScyllaDB Community
--------------------------

Join the ScyllaDB Open Source community:
Join the ScyllaDB community:

* Contribute to the ScyllaDB Open Source `project <https://github.com/scylladb/scylladb>`_.
* Join the `ScyllaDB Community Forum <https://forum.scylladb.com/>`_.
* Join our `Slack Channel <https://slack.scylladb.com/>`_.

Expand Down
16 changes: 0 additions & 16 deletions docs/kb/decode-stack-trace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,28 +31,12 @@ Install the Debug binaries according to your OS distribution

.. group-tab:: RPM based distributions

For ScyllaDB Enterprise:

.. code-block:: none
yum install scylla-enterprise-debuginfo
For ScyllaDB Open Source:

.. code-block:: none
yum install scylla-debuginfo
.. group-tab:: DEB based distributions

For ScyllaDB Enterprise:

.. code-block:: none
apt-get install scylla-enterprise-server-dbg
For ScyllaDB Open Source:

.. code-block:: none
apt-get install scylla-server-dbg
Expand Down
2 changes: 1 addition & 1 deletion docs/kb/perftune-modes-sync.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Updating the Mode in perftune.yaml After a ScyllaDB Upgrade
==============================================================

In versions 5.1 (ScyllaDB Open Source) and 2022.2 (ScyllaDB Enterprise), we improved ScyllaDB's performance by `removing the rx_queues_count from the mode
We improved ScyllaDB's performance by `removing the rx_queues_count from the mode
condition <https://github.com/scylladb/seastar/pull/949>`_. As a result, ScyllaDB operates in
the ``sq_split`` mode instead of the ``mq`` mode (see :doc:`Seastar Perftune </operating-scylla/admin-tools/perftune>` for information about the modes).
If you upgrade from an earlier version of ScyllaDB, your cluster's existing nodes may use the ``mq`` mode,
Expand Down
3 changes: 1 addition & 2 deletions docs/operating-scylla/admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,10 +252,9 @@ discard, or trim, any blocks no longer in use by the filesystem.
Experimental Features
=====================

ScyllaDB Open Source uses experimental flags to expose non-production-ready features safely. These features are not stable enough to be used in production, and their API will likely change, breaking backward or forward compatibility.
ScyllaDB uses experimental flags to expose non-production-ready features safely. These features are not stable enough to be used in production, and their API will likely change, breaking backward or forward compatibility.

In recent ScyllaDB versions, these features are controlled by the ``experimental_features`` list in scylla.yaml, allowing one to choose which experimental to enable.
For example, some of the experimental features in ScyllaDB Open Source 4.5 are: ``udf``, ``alternator-streams`` and ``raft``.
Use ``scylla --help`` to get the list of experimental features.

ScyllaDB Enterprise and ScyllaDB Cloud do not officially support experimental Features.
Expand Down
2 changes: 1 addition & 1 deletion docs/operating-scylla/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ ScyllaDB for Administrators
:id: "getting-started"
:class: my-panel

* :doc:`ScyllaDB Features </features/index>` - Feature list for ScyllaDB Open Source and ScyllaDB Enterprise
* :doc:`ScyllaDB Features </features/index>` - Feature list for ScyllaDB



Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Remove a Seed Node from Seed List
This procedure describes how to remove a seed node from the seed list.

.. note::
The seed concept in gossip has been removed. Starting with ScyllaDB Open Source 4.3 and ScyllaDB Enterprise 2021.1, a seed node
The seed concept in gossip has been removed. A seed node
is only used by a new node during startup to learn about the cluster topology. As a result, you only need to configure one
seed node in a node's ``scylla.yaml`` file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Replacing a Dead Seed Node
===========================

.. note::
The seed concept in gossip has been removed. Starting with ScyllaDB Open Source 4.3 and ScyllaDB Enterprise 2021.1,
a seed node is only used by a new node during startup to learn about the cluster topology. As a result, there's no need
The seed concept in gossip has been removed.
A seed node is only used by a new node during startup to learn about the cluster topology. As a result, there's no need
to replace the node configured with the ``seeds`` parameter in the ``scylla.yaml`` file.

In ScyllaDB, it is not possible to bootstrap a seed node. The following steps describe how to replace a dead seed node.
Expand Down
2 changes: 1 addition & 1 deletion docs/using-scylla/integrations/integration-ansible.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Install ScyllaDB with Ansible
You can use the Ansible roles and the playbook examples that follow to deploy and maintain ScyllaDB clusters.
There are roles for creating a ScyllaDB cluster, a ScyllaDB Manager, ScyllaDB Monitoring Stack, and a Loader.
These roles can be used independently or together, using each role's outputs.
You can use these roles with ScyllaDB (Open Source and Enterprise), ScyllaDB Manager, and ScyllaDB Monitoring Stack.
You can use these roles with ScyllaDB, ScyllaDB Manager, and ScyllaDB Monitoring Stack.

To get started, visit the `GitHub project <https://github.com/scylladb/scylla-ansible-roles/>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-scylla/integrations/integration-kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Integrate ScyllaDB with Kafka
scylla-cdc-source-connector

Apache Kafka is capable of delivering reliable, scalable, high-throughput data streams across a myriad of data sources and sinks.
A great number of open source users and enterprise customers use ScyllaDB and Kafka together.
A great number of customers use ScyllaDB and Kafka together.
You can use ScyllaDB and Apache Kafka in integration solutions, such as creating a scalable backend for an IoT service.
If you have tested your application with ScyllaDB and Kafka and want to publish the results, contact us using the `community forum <https://forum.scylladb.com>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-scylla/mig-tool-review.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ScyllaDB Migration Tools: An Overview
=======================================

The following migration tools are available for migrating to ScyllaDB from compatible databases,
such as Apache Cassandra, or from other ScyllaDB clusters (ScyllaDB Open Source or Enterprise):
such as Apache Cassandra, or from other ScyllaDB clusters:

* From SSTable to SSTable
- Using nodetool refresh, :ref:`Load and Stream <nodetool-refresh-load-and-stream>` option.
Expand Down

0 comments on commit e340d6a

Please sign in to comment.