Commit Graph

342 Commits

Author SHA1 Message Date
Anna Stuchlik
274691f45e doc: fix the example of UDT in the SELECT statement
Closes #11067
2022-07-18 18:26:06 +03:00
Nadav Har'El
a02db6f928 Merge 'doc: add the upgrade guide from 2021.1 to 2022.1' from Anna Stuchlik
Fix https://github.com/scylladb/scylla-docs/issues/4040
Fix https://github.com/scylladb/scylla-docs/issues/4128

This PR adds the upgrade guides from ScyllaDB Enterprise 2021.1 to 2022.1. They are based on the previous guides.

Closes #11036

* github.com:scylladb/scylla:
  doc: add the description of the new metrics in 2022.1
  doc: remove the upgrade guide for Ubuntu 16.04 (no longer supported in version 2022.1)
  doc: remove the outdated warning
  Update docs/upgrade/_common/upgrade-guide-from-2021.1-to-2022.1-ubuntu-and-debian.rst
  Update docs/upgrade/_common/upgrade_to_2022_warning.rst
  doc: add a space on line 60 to fix the warning
  doc: document metric update for 2022.1
  doc: add the upgrade guide from 2021.1 to 2022.1
2022-07-18 14:14:57 +03:00
Anna Stuchlik
68750b7612 doc: migrate the update about dropping tables from the scylla-docs repo
Closes #11032
2022-07-14 14:08:54 +03:00
Anna Stuchlik
95725c04d1 doc: remove the info about Katacoda and the link to the nonexistent lab
Closes #11031
2022-07-14 14:05:59 +03:00
Anna Stuchlik
3254378375 doc: add the description of the new metrics in 2022.1 2022-07-14 12:29:46 +02:00
Anna Stuchlik
e756bf5067 doc: remove the upgrade guide for Ubuntu 16.04 (no longer supported in version 2022.1) 2022-07-14 12:02:58 +02:00
Anna Stuchlik
68eae4d4e0 doc: remove the outdated warning 2022-07-14 11:55:15 +02:00
David Garcia
0ee5b50bac doc: create migration redirections
Update redirects

Closes #11022
2022-07-14 11:53:41 +03:00
Anna Stuchlik
773be9fc02 Update docs/upgrade/_common/upgrade-guide-from-2021.1-to-2022.1-ubuntu-and-debian.rst
Co-authored-by: Tzach Livyatan <tzach.livyatan@gmail.com>
2022-07-14 10:24:27 +02:00
Anna Stuchlik
bca51c9bb9 Update docs/upgrade/_common/upgrade_to_2022_warning.rst
Co-authored-by: Tzach Livyatan <tzach.livyatan@gmail.com>
2022-07-14 09:17:51 +02:00
Anna Stuchlik
ca8c5fd2c4 doc: add a space on line 60 to fix the warning 2022-07-13 16:37:54 +02:00
Anna Stuchlik
ee1eb85ebc doc: document metric update for 2022.1 2022-07-13 16:24:30 +02:00
Anna Stuchlik
b3566391e6 doc: add the upgrade guide from 2021.1 to 2022.1 2022-07-13 16:17:51 +02:00
David Garcia
0c2a18af2d doc: enable faster builds
Closes #11023
2022-07-12 16:33:38 +03:00
Nadav Har'El
15ed0a441e Merge 'scylla-gdb.py: assortment of task filtering improvements, scylla fiber going backwards' from Botond Dénes
This series includes an assortment of loosely related improvements developed for a recent investigation. The changes include:
* Fix broken `std_deque` wrapper.
* Make `scylla smp-queues` fast.
* Teach `scylla smp-queues` to filter for both sender CPU (`--from`) and receiver CPU (`--to`) or both.
* Teach `scylla smp-queues` to make histogram over content of the queues -- i.e. the type of tasks in the smp queues.
* Teach `scylla smp-queues` to filter for tasks belonging to a certain scheduling group.
* Teach `scylla task_histogram` to include only tasks in the histogram.
* Teach `scylla task_histogram` to filter for tasks belonging to a certain scheduling group.
* Teach `scylla-fiber` to walk in both directions.

And some refactoring.

Fixes: https://github.com/scylladb/scylla/issues/7059

Closes #11019

* github.com:scylladb/scylla:
  docs/dev/debugging.md: update continuation chain traversal guide
  scylla-gdb.py: scylla fiber: walk continuation chain in both directions
  scylla-gdb.py: scylla fiber: allow passing analyzed pointers to _probe_pointer()
  scylla-gdb.py: scylla fiber: hoist preparatory code out of _walk()
  scylla-gdb.py: scylla task_histogram: add --scheduling-groups option
  scylla-gdb.py: scylla task_histogram: add --filter-tasks option
  scylla-gdb.py: scylla task_histogram: use histogram class
  scylla-gdb.py: scylla-fiber: extract symbol matching logic
  scylla-gdb.py: histogram: add limit feature
  scylla-gdb.py: histogram: handle formatting errors
  scylla-gdb.py: intrusive_slist: avoid infinite recursion in __len__()
  scylla-gdb.py: scylla smp-queues: add --scheduling-group option
  scylla-gdb.py: scylla smp-queues: add --content switch
  scylla-gdb.py: smp-queue: add filtering capability
  scylla-gdb.py: make scylla smp-queues fast
  scylla-gdb.py: fix disagreement between std_deque len() and iter()
2022-07-12 15:38:23 +03:00
Botond Dénes
5c56125187 docs/dev/debugging.md: update continuation chain traversal guide
`scylla fiber` is the way to traverse in both directions now.
2022-07-12 07:27:45 +03:00
Anna Stuchlik
0bf99b25c9 doc: fix errors -fix the indent in the conf.py file 2022-07-11 12:31:59 +02:00
Anna Stuchlik
ae9ed315d1 doc: fix the path to Alternator 2022-07-11 12:31:59 +02:00
Anna Stuchlik
a1d9f0f0c8 doc: fix errors - add Alternator to the toctree 2022-07-11 12:31:30 +02:00
Anna Stuchlik
81949bbc7a doc: fix errors- update the conf.py file 2022-07-11 12:18:47 +02:00
Anna Stuchlik
2e95bd0ed1 doc: fix errors - remove the CNAME file 2022-07-11 12:17:33 +02:00
Anna Stuchlik
7b5dfde56a doc: add the CNAME and robots files 2022-07-11 12:16:53 +02:00
Anna Stuchlik
8d86dfa929 doc: move index and README from scylla-docs repo 2022-07-11 12:14:40 +02:00
Anna Stuchlik
6e97b83b60 doc: move the documentation from the scylla-docs repo 2022-07-11 12:14:02 +02:00
Anna Stuchlik
bb41457f73 doc: remove the old index file 2022-07-11 12:12:15 +02:00
Avi Kivity
973d2a58d0 Merge 'docs: move docs to docs/dev folder' from David Garcia
In order to allow our Scylla OSS customers the ability to select a version for their documentation, we are migrating the Scylla docs content to the Scylla OSS repository. This PR covers the following points of the [Migration Plan](https://docs.google.com/document/d/15yBf39j15hgUVvjeuGR4MCbYeArqZrO1ir-z_1Urc6A/edit#):

1. Creates a subdirectory for dev docs: /docs/dev
2. Moves the existing dev doc content in the scylla repo to /docs/dev, but keep Alternator docs in /docs.
3. Flattens the structure in /docs/dev (remove the subfolders).
4. Adds redirects from `scylla.docs.scylladb.com/<version>/<document>` to `https://github.com/scylladb/scylla/blob/master/docs/dev/<document>.md`
5. Excludes publishing docs for /docs/devs.

1. Enter the docs folder with `cd docs`.
2. Run `make redirects`.
3. Enter the docs folder and run `make preview`. The docs should build without warnings.
4. Open http://127.0.0.1:5500 in your browser. You shoul donly see the alternator docs.
5. Open http://127.0.0.1:5500/stable/design-notes/IDL.html in your browser. It should redirect you to https://github.com/scylladb/scylla/blob/master/docs/dev/IDL.md and raise a 404 error since this PR is not merged yet.
6. Surf the `docs/dev` folder. It should have all the scylla project internal docs without subdirectories.

Closes #10873

* github.com:scylladb/scylla:
  Update docs/conf.py
  Update docs/dev/protocols.md
  Update docs/dev/README.md
  Update docs/dev/README.md
  Update docs/conf.py
  Fix broken links
  Remove source folder
  Add redirections
  Move dev docs to docs/dev
2022-07-03 20:37:11 +03:00
David Garcia
fc59ebc2c3 Update docs/conf.py 2022-06-30 19:12:08 +01:00
David Garcia
a1b990075e Update docs/dev/protocols.md 2022-06-30 19:11:09 +01:00
David Garcia
d555febdd3 Update docs/dev/README.md
Co-authored-by: annastuchlik <37244380+annastuchlik@users.noreply.github.com>
2022-06-30 19:10:41 +01:00
David Garcia
350abdd72d Update docs/dev/README.md
Co-authored-by: annastuchlik <37244380+annastuchlik@users.noreply.github.com>
2022-06-30 19:10:33 +01:00
David Garcia
66a77f74d2 Update docs/conf.py
Co-authored-by: annastuchlik <37244380+annastuchlik@users.noreply.github.com>
2022-06-30 19:10:23 +01:00
David Garcia
b85843b9cc Fix broken links
Fix broken links
2022-06-28 15:19:36 +01:00
David Garcia
b87537c767 Remove source folder
Remove source folder

Remove source folder
2022-06-28 15:07:35 +01:00
David Garcia
8e7ebea335 Merge remote-tracking branch 'upstream/master' into move-dev-docs 2022-06-28 11:02:38 +01:00
David Garcia
5adb5875f1 Add redirections 2022-06-28 09:39:14 +01:00
Nadav Har'El
e22364dcc5 doc, alternator: split "experimental" features from "unimplemented" ones
Currently in docs/alternator/compatibility.md experimental features
and unimplemented features are bunched together under one heading
("unimplemented features"). In this patch we separate them into two
sections. This makes the "unimplemented features" section shorter,
and also allows us to link to the new "experimental features" section
separately.

Signed-off-by: Nadav Har'El <nyh@scylladb.com>

Closes #10893
2022-06-28 08:08:50 +03:00
David Garcia
bb21c3c869 Move dev docs to docs/dev 2022-06-24 18:07:08 +01:00
Piotr Sarna
f2bb676d27 docs: mention python in debugging.md
Evaluating Python code from within gdb is priceless,
especially that all helper classes and functions sourced from
scylla-gdb.py can be used in there. This commit adds a paragraph
in debugging.md mentioning this tool.

Closes #10869
2022-06-24 15:16:43 +03:00
Piotr Dulikowski
a55d7ad46d docs: design doc for per-partition rate limiting 2022-06-22 20:07:58 +02:00
Piotr Dulikowski
efc3953c0a transport: add rate_limit_error
Adds a CQL protocol extension which introduces the rate_limit_error. The
new error code will be used to indicate that the operation failed due to
it exceeding the allowed per-partition rate limit.

The error code is supposed to be returned only if the corresponding CQL
extension is enabled by the client - if it's not enabled, then
Config_error will be returned in its stead.
2022-06-22 20:07:58 +02:00
Botond Dénes
1718ed9e9f docs/contribute/maintainer.md: add merging and backporting guidelines 2022-06-16 10:29:26 +03:00
Botond Dénes
4542486f23 docs/contribute/review-checklist.md: add section about patch organization 2022-06-16 10:29:26 +03:00
Botond Dénes
25f4ad1543 docs/contribute/maintainer.md: expand section on git submodule sync
git submodule sync is only dangerous if one is using certain workflows.
Explain what the danger are and when it is safe to use.
2022-06-16 10:29:21 +03:00
Konstantin Osipov
29f8ba2c5e raft: add Raft design nodes to the docs
Closes #10504
2022-06-08 12:33:51 +02:00
Michael Livshin
9a541c7c58 docs: document recently-added Scylla sstable metadata sections
Signed-off-by: Michael Livshin <michael.livshin@scylladb.com>
2022-06-02 19:40:52 +03:00
Avi Kivity
8136f7bc4b doc: document list subscripts usable in WHERE clause 2022-05-30 13:29:49 +03:00
Avi Kivity
e99b99e537 docs: unconfuse doc test checker wrt gdbinit file
The docs test dislike the gdbinit link because it refers out of
the source tree. Unconfuse the tests by removing the link. It's
sad, but the file is more easily used by referring to it rather
than viewing it, so give a hint about that too.

Closes #10650
2022-05-24 20:20:30 +03:00
Pavel Emelyanov
0c40b69411 storage_service: Make _cdc_gen_id local variable
Same as with _bootstrap_tokens -- this variable is only needed
throughout a single function invocation, so it doesn't have to be a
class member.

Signed-off-by: Pavel Emelyanov <xemul@scylladb.com>
2022-05-23 12:55:30 +03:00
Pavel Emelyanov
80bd317292 storage_service: Make _bootstrap_tokens local variable
Now it's a member on storage_service, but it was such just to carry the
set of tokens between to subsequent calls. Now when all the joining
happens in one function, the set can become local variable.

Signed-off-by: Pavel Emelyanov <xemul@scylladb.com>
2022-05-23 12:55:30 +03:00
Piotr Sarna
e54a4ebdcb docs: add a paragraph on PRUNE MATERIALIZED VIEW statement 2022-05-19 10:16:04 +02:00