Commit Graph

20 Commits

Author SHA1 Message Date
Piotr Smaron
0ec485845b Clarify documentation build instructions
Closes scylladb/scylladb#27606
2025-12-16 06:56:00 +02:00
Anna Stuchlik
592d45a156 doc: remove references to Open Source from README
This commit removes the references to ScyllaDB Open Source from the README file for documentation.
In addition, it updates the link where the documentation is currently published.

We've removed Open Source from all the documentation, but the README was missed.
This commit fixes that.

Closes scylladb/scylladb#24477
2025-06-25 11:38:46 +03:00
Anna Stuchlik
44a807f5bc doc: improve the README file in the docs folder
This commit improves the README file so that it's more helpful
to documentation contributors. Especially, it:
- Adds the link to the prerequisites.
- Add information on troubleshooting (checking the links, headings, etc.)
- Removes the section on creating a knowledge base article, as we no longer
  promote adding KBs in favor of creating a coherent documentation set.

Fixes https://github.com/scylladb/scylladb/issues/21257

Closes scylladb/scylladb#21262
2024-10-28 09:55:40 +02:00
Laszlo Ersek
a0ffbd5bcf docs/README.md: fix minimum poetry version
Commit 2a3012db7f ("docs/README.md: expand prerequisites list",
2022-08-31) referenced poetry release 1.12, which does not exist even
today (as of this writing, the latest release is 1.8.4). The intent was
probably 1.1.12.

Copy the minimum version from "sphinx-scylladb-theme": 1.8.1 (see
"docs/source/getting-started/installation.rst" and
"docs/source/getting-started/quickstart.rst" at commit f7c26b422572).

Signed-off-by: Laszlo Ersek <laszlo.ersek@scylladb.com>
2024-10-15 12:19:21 +02:00
Botond Dénes
2a3012db7f docs/README.md: expand prerequisites list
poetry and make was missing from the list.

Closes #11391
2022-08-31 17:00:59 +03:00
Anna Stuchlik
82f96327d4 docs: remove outdated information -Vale support, Lint, warning about livereload 2022-07-27 22:07:40 +02:00
Anna Stuchlik
b31cb94944 doc: improve the section about knowledge base articles in README 2022-07-27 13:49:53 +02:00
Anna Stuchlik
ecf1633cb3 doc: replace distribution names with a generic phrase: Linux distributions 2022-07-27 13:28:05 +02:00
Anna Stuchlik
456f2f7c47 doc: remove irrelevant guidelines for contributors from README 2022-07-27 13:18:20 +02:00
Anna Stuchlik
b3648c1403 doc: language improvements in the doc's README 2022-07-27 10:28:59 +02:00
Anna Stuchlik
d4bc030705 doc: reogrganize the content in the doc's README 2022-07-27 10:18:01 +02:00
Anna Stuchlik
e989eed75b doc: update the Prerequisites section in the doc's README 2022-07-27 10:03:09 +02:00
Anna Stuchlik
48703adf59 doc: remove redundant information from README in the docs folder 2022-07-27 09:56:24 +02:00
Anna Stuchlik
3f097f3285 doc: add key information to the introduction in README in the docs folder 2022-07-27 09:50:13 +02:00
Anna Stuchlik
8d86dfa929 doc: move index and README from scylla-docs repo 2022-07-11 12:14:40 +02:00
David Garcia
bb21c3c869 Move dev docs to docs/dev 2022-06-24 18:07:08 +01:00
Botond Dénes
4d581f1bb3 docs/README.md: guides: also mention running and debugging
Signed-off-by: Botond Dénes <bdenes@scylladb.com>
Message-Id: <20210120083304.36447-1-bdenes@scylladb.com>
2021-01-20 16:07:29 +02:00
dgarcia360
fd5f0c3034 docs: add organization
Closes #7818
2020-12-22 15:33:31 +02:00
dgarcia360
1304f6a0bb docs: fixed warnings
docs: fixed warnings
2020-12-03 17:40:34 +01:00
Botond Dénes
e52712f82c docs: add README.md
Signed-off-by: Botond Dénes <bdenes@scylladb.com>
Message-Id: <20191010103926.34705-2-bdenes@scylladb.com>
2019-10-10 14:14:09 +03:00