From 70d9352cec5cc801230edda88883a7253cdebb44 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Fri, 9 May 2025 14:50:59 +0200 Subject: [PATCH] doc: remove the redundant pages This commit removes two redundant pages and adds the related redirections. - The Tutorials page is a duplicate and is not maintained anymore. Having it in the docs hurts the SEO of the up-to-date Tutorias page. - The Contributing page is not helpful. Contributions-related information should be maintained in the project README file. Fixes https://github.com/scylladb/scylladb/issues/17279 Fixes https://github.com/scylladb/scylladb/issues/24060 Closes scylladb/scylladb#24090 (cherry picked from commit eed8373b77f872d0a9ca3722bffe757cb50ac6f2) Closes scylladb/scylladb#24220 --- docs/_utils/redirects.yaml | 5 +++++ docs/contribute.rst | 31 ------------------------------ docs/getting-started/index.rst | 1 - docs/getting-started/tutorials.rst | 21 -------------------- docs/index.rst | 1 - 5 files changed, 5 insertions(+), 54 deletions(-) delete mode 100644 docs/contribute.rst delete mode 100644 docs/getting-started/tutorials.rst diff --git a/docs/_utils/redirects.yaml b/docs/_utils/redirects.yaml index 6d7a8b03a7..50c45b1669 100644 --- a/docs/_utils/redirects.yaml +++ b/docs/_utils/redirects.yaml @@ -2,6 +2,11 @@ #old path: new path +# Remove reduntant pages + +/stable/getting-started/tutorials: https://docs.scylladb.com/stable/get-started/develop-with-scylladb/tutorials-example-projects.html +/stable/contribute: https://github.com/scylladb/scylladb/blob/master/CONTRIBUTING.md + # Remove an oudated article /stable/troubleshooting/nodetool-memory-read-timeout.html: /stable/troubleshooting/index.html diff --git a/docs/contribute.rst b/docs/contribute.rst deleted file mode 100644 index 08acf73e83..0000000000 --- a/docs/contribute.rst +++ /dev/null @@ -1,31 +0,0 @@ -Contribute to ScyllaDB -======================= - -Thank you for your interest in making ScyllaDB better! -We appreciate your help and look forward to welcoming you to the ScyllaDB Community. -There are two ways you can contribute: - -* Send a patch to the ScyllaDB source code -* Write documentation for ScyllaDB Docs - - -Contribute to ScyllaDB's Source Code ------------------------------------- -ScyllaDB developers use patches and email to share and discuss changes. -Setting up can take a little time, but once you have done it the first time, it’s easy. - -The basic steps are: - -* Join the ScyllaDB community -* Create a Git branch to work on -* Commit your work with clear commit messages and sign-offs. -* Send a PR or use ``git format-patch`` and ``git send-email`` to send to the list - - -The entire process is `documented here `_. - -Contribute to ScyllaDB Docs ---------------------------- - -Each ScyllaDB project has accompanying documentation. For information about contributing documentation to a specific ScyllaDB project, refer to the README file for the individual project. -For general information or to contribute to the ScyllaDB Sphinx theme, read the `Contributor's Guide `_. \ No newline at end of file diff --git a/docs/getting-started/index.rst b/docs/getting-started/index.rst index 05a2c90fce..6161102066 100644 --- a/docs/getting-started/index.rst +++ b/docs/getting-started/index.rst @@ -11,7 +11,6 @@ Getting Started requirements Migrate to ScyllaDB Integration Solutions - tutorials .. panel-box:: :title: ScyllaDB Requirements diff --git a/docs/getting-started/tutorials.rst b/docs/getting-started/tutorials.rst deleted file mode 100644 index aaf5f659bd..0000000000 --- a/docs/getting-started/tutorials.rst +++ /dev/null @@ -1,21 +0,0 @@ -============ -Tutorials -============ - -The tutorials will show you how to use ScyllaDB as a data source for an application. - - -ScyllaDB Tutorial -=================== - -`Build an IoT App with sensor simulator and a REST API `_ - -ScyllaDB Cloud Tutorial -======================= - -`Implement CRUD operations with a TODO App `_ - -ScyllaDB Cloud Feature Store Tutorial -===================================== - -`Build a machine learning (ML) feature store with ScyllaDB `_ diff --git a/docs/index.rst b/docs/index.rst index 8c456c17c3..3ecd28d75d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -73,6 +73,5 @@ In addition, you can read our `blog `_ and atten kb/index reference/index faq - Contribute to ScyllaDB 2024.2 and earlier documentation