search

scylladb / care-pet

Care Pet IoT ScyllaDB example
https://care-pet.docs.scylladb.com/
Apache License 2.0
48 stars 28 forks source link

Provide code snippets to cover standard usage patterns #15

Closed sitano closed 1 year ago

sitano commented 4 years ago
  1. Provide code snippets to cover standard usage patterns
  2. Multi-platform

Expected snippets to have:

  1. how to initialize new project with drivers
  2. how to connect to db
  3. how to define a data model
  4. how to execute a query
  5. how to work with a data model
  6. how to read from db
  7. how to create schema
  8. how to write cassandra-stress profile for your app and execute it

What we have:

Go-specific:

Thus Go part is missing: 3, 6, 7

Java-specific:

Thus Go part is missing: 5, 6, 7

TODO:

sitano commented 4 years ago

An example of tabs doc syntax:

.. tabs::

   .. group-tab:: CentOS 7, Ubuntu 16.04/18.04, Debian 8/9

      .. code-block:: shell

         sudo systemctl stop scylla-server

   .. group-tab:: Ubuntu 14.04, Debian 7

      .. code-block:: shell

         sudo service scylla-server stop

   .. group-tab:: Docker

      .. code-block:: shell

         docker exec -it some-scylla supervisorctl stop scylla

      (without stopping *some-scylla* container)

This is the syntax
Note how each tab is indented spacing is "space sensitive"

the code-block directive can be any language and will use syntax highlighting by default.
lauranovich commented 3 years ago

Related to https://github.com/scylladb/care-pet/issues/10 and https://github.com/scylladb/care-pet/issues/26

tzach commented 1 year ago

Closing. Most point are done.