From 9076a944c50e189c5ec69f7ac3f4a4d09b14bf91 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Tue, 16 Jan 2024 13:26:54 +0100 Subject: [PATCH] doc: improve the ScyllaDB for Developers page This commit improves the developer-oriented section of the core documentation: - Added links to the developer sections in the new Get Started guide (Develop with ScyllaDB and Tutorials and Example Projects) for ease of access. - Replaced the outdated Learn to Use ScyllaDB page with a link to the up-to-date page in the Get Started guide. This involves removing the learn.rst file and adding an appropriate redirection. - Removed the Apache Copyrights, as this page does not need it. - Removed the Features panel box as there was only one feature listed, which looked weird. Also, we are in the process of removing the Features section. Closes scylladb/scylladb#16800 --- docs/_utils/redirects.yaml | 3 ++ docs/operating-scylla/index.rst | 1 - docs/using-scylla/index.rst | 47 ++++++++---------- docs/using-scylla/learn.rst | 85 --------------------------------- 4 files changed, 23 insertions(+), 113 deletions(-) delete mode 100644 docs/using-scylla/learn.rst diff --git a/docs/_utils/redirects.yaml b/docs/_utils/redirects.yaml index 4ee14b2b5e..4676644c6c 100644 --- a/docs/_utils/redirects.yaml +++ b/docs/_utils/redirects.yaml @@ -1,6 +1,9 @@ ### a dictionary of redirections #old path: new path +# Remove the Learn page (replaced with a link to a page in a different repo) + +/stable/using-scylla/learn: https://docs.scylladb.com/stable/get-started/learn-resources/index.html # Removed the outdated upgrade guides diff --git a/docs/operating-scylla/index.rst b/docs/operating-scylla/index.rst index a01575e7a5..8e785fca5b 100644 --- a/docs/operating-scylla/index.rst +++ b/docs/operating-scylla/index.rst @@ -58,7 +58,6 @@ ScyllaDB for Administrators :id: "getting-started" :class: my-panel - * :doc:`Learn To Use Scylla ` - Scylla University offers many courses. Pick a course and get started on your path to becoming a Scylla expert. * :doc:`Scylla Features ` - Feature list for Scylla Open Source and Scylla Enterprise diff --git a/docs/using-scylla/index.rst b/docs/using-scylla/index.rst index 803879cb42..57f1d86e4e 100644 --- a/docs/using-scylla/index.rst +++ b/docs/using-scylla/index.rst @@ -5,47 +5,40 @@ ScyllaDB for Developers :maxdepth: 2 :hidden: - learn - Scylla Alternator - Scylla Features - Scylla Drivers + Develop with ScyllaDB + Tutorials and Example Projects + Learn to Use ScyllaDB + ScyllaDB Alternator + ScyllaDB Features + ScyllaDB Drivers Workload Attributes .. panel-box:: - :title: Develop Your App with Scylla + :title: Get Started :id: "getting-started" :class: my-panel - * :doc:`Scylla Drivers ` - Scylla and third-party drivers for CQL and DynamoDB - * :doc:`Scylla Alternator ` - The Open Source DynamoDB-compatible API + * `Get Started with ScyllaDB `_ + * `Tutorials and Example Projects `_ + * `Learn to Use ScyllaDB `_ + +.. panel-box:: + :title: Develop Your App with ScyllaDB + :id: "getting-started" + :class: my-panel + + * :doc:`ScyllaDB Drivers ` - ScyllaDB and third-party drivers for CQL and DynamoDB + * :doc:`ScyllaDB Alternator ` - The Open Source DynamoDB-compatible API * :doc:`CQL Reference ` - Reference for the Apache Cassandra Query Language (CQL) and its ScyllaDB extensions -.. panel-box:: - :title: Features - :id: "getting-started" - :class: my-panel - - * :doc:`Workload Attributes ` - - .. panel-box:: - :title: Scylla Tools and Resources + :title: ScyllaDB Tools and Resources :id: "getting-started" :class: my-panel - * :doc:`Scylla Tools ` - Tools for testing and integrating with Scylla + * :doc:`ScyllaDB Tools ` - Tools for testing and integrating with Scylla * :doc:`cqlsh ` - A command line shell for interacting with ScyllaDB through CQL - -.. panel-box:: - :title: Learn More About Scylla - :id: "getting-started" - :class: my-panel - - * :doc:`Learn To Use Scylla ` - Scylla University offers many courses. Pick a course and get started on your path to becoming a Scylla expert. - * :doc:`Scylla Features ` - Feature list for Scylla Open Source and Scylla Enterprise - -.. include:: /rst_include/apache-copyrights.rst diff --git a/docs/using-scylla/learn.rst b/docs/using-scylla/learn.rst deleted file mode 100644 index 9c0ccbde39..0000000000 --- a/docs/using-scylla/learn.rst +++ /dev/null @@ -1,85 +0,0 @@ -====================== -Learn To Use ScyllaDB -====================== - -.. toctree:: - :maxdepth: 2 - :hidden: - - ScyllaDB University - Course catalog - ScyllaDB Essentials - Basic Data Modeling - Advanced Data Modeling - MMS - Learn by Example - Care-Pet an IoT Use Case and Example - -.. panel-box:: - :title: ScyllaDB University - :id: "getting-started" - :class: my-panel - - - See the `course catalog `_. Pick a course and get started on your path to becoming a ScyllaDB expert. Visit `ScyllaDB University `_ to register! - - -.. panel-box:: - :title: ScyllaDB Essentials - :id: "getting-started" - :class: my-panel - - The `ScyllaDB Essentials - Overview of ScyllaDB and NoSQL Basics `_ course explains basic concepts of NoSQL databases. You will gain knowledge of ScyllaDB features and advantages, including ScyllaDB architecture, data model and installation. - -.. panel-box:: - :title: Data Modeling - :id: "getting-started" - :class: my-panel - - * `Basic Data Modeling `_ - This is an intermediate level course that explains basic data modeling techniques including information on workflow application, query analysis, denormalization and other NoSQL data modeling topics. - * `Advanced Data Modeling `_ - This is an intermediate level course that explains advanced data modeling techniques including information on workflow application, query analysis, denormalization and other NoSQL data modeling topics. - * `How to Write Better Apps `_ - An intermediate to advanced level lesson that explains how to write better applications. It covers application development, caveats, performance, and what you should or shouldn’t do. - -.. panel-box:: - :title: ScyllaDB Operations - :id: "getting-started" - :class: my-panel - - The course `ScyllaDB Operations and Administration `_ is a more advanced course that covers different administration and operations topics such as Compaction, Security, Manager and Monitoring and much more. - -.. panel-box:: - :title: ScyllaDB Drivers - :id: "getting-started" - :class: my-panel - - `Using ScyllaDB Drivers `_ focuses on ScyllaDB drivers and how to use them for application development. Some of the languages covered are Java, Python, Golang, Nodejs and Rust. - -.. panel-box:: - :title: ScyllaDB Alternator - :id: "getting-started" - :class: my-panel - - `ScyllaDB Alternator `_ is an open-source project that gives ScyllaDB compatibility with DynamoDB. The course is work in progress, it covers migrating existing DynamoDB applications to work with ScyllaDB as well as creating new ones that use the DynamoDB API. - -.. panel-box:: - :title: Guided Exercises - :id: "getting-started" - :class: my-panel - - * MMS Course: Mutants have emerged from the shadows and are wreaking havoc on Earth! `Learn ScyllaDB step by step `_ though examples based on a "true story". - * Care-Pet: an IoT Use case example. `Learn to Use ScyllaDB `_ using this use case. - -.. panel-box:: - :title: Tech Talks and Scylla Summit Sessions - :id: "getting-started" - :class: my-panel - - * Watch the `2021 Scylla Summit `_ sessions on demand - * Watch a `tech-talk `_ on demand. - -.. panel-box:: - :title: Webinars - :id: "getting-started" - :class: my-panel - - * Register for a `Webinar `_ or watch one on demand. -