Skip to content

doc: Release the documentation for GA #471

Description

@annastuchlik

This is a list of activities around the driver documentation for GA:

  • BEFORE TAGGING: Remove this disclaimer from the landing page: This driver is currently in the experimental state. We are working on features necessary for the driver to be considered production ready.
  • BEFORE TAGGING: Verify the default for logging. See Logging docs #469 ("Logging is enabled by default. When no logLevel is specified, events at warning level and above are captured. WARNING This default behavior may be changed before 1.0 release. We recommend explicitly setting desired logging level when using this driver."
  • Publish the documentation for the GA version (I guess it will be v1.0.0).
    Update the conf.py file: add v1.0.0 to the tag lists, set v1.0.0 as latest, set main as unstable.
    See the unmerged PR I opened for version v0.5.1 and do the same for the GA version. You can compare with the conf.py configuration in the Rust Driver.
  • Update the Driver Support page. Remove the beta version from the Supported Versions column for the Nodejs driver and add the GA version.
    The source file to update is here: https://github.com/scylladb/scylladb-docs-homepage/blob/main/docs/versioning/driver-support.rst (add me as a reviewer).

@wprzytula FYI

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Fields

No fields configured for Task.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions