docs: Issue in page Examples

[gcarmin]

I would like to report an issue in page https://manager.docs.scylladb.com/branch-3.0/backup/examples

Problem

It seems that the doc's does not up[dated with SM 3.X

one example - from the Example page, in order to schedule a backup you should run:

sctool backup -c prod-cluster -L 's3:my-backups' -s '2019-12-09T15:16:05Z' -i 24h

I've modified it to:

azureuser@gc-mng-mon-01:~$ sctool backup -L 'azure:scyllabackup' -s '2023-04-04T10:00:00Z' -i 1h Flag --start-date has been deprecated, use cron instead Flag --interval has been deprecated, use cron instead

[tzach]

This might be a ccross the board, with all examples and CLI reference

[annastuchlik]

@dgarcia360 FYI

[dgarcia360]

@tzach @annastuchlik This project autogenerates part of the reference docs ( see Sctool CLI > Backup source) from yaml files.

To regenerate the source YAML files, repo maintainers should run the command make docs on the root directory.

Examples or guides in other modules of the documentation that use commands need to be updated manually if the contract changes (such as Backup > Examples).

[annastuchlik]

@karol-kokoszka Hi Karol, This one is on you. Also, can you make it possible for me to add the "documentation" label in this project?

[karol-kokoszka]

@annastuchlik you should be able to triage issues now. Are you a part of some docs team on github already ? I'm asking because I added you directly to this repo, but the best is to give access to documentation group if there is any.

[karol-kokoszka]

make docs is done on branch-3.0

@dgarcia360 one question, do you know why make docs replaces UTC with Europe/Warsaw ? See my revert commit https://github.com/scylladb/scylla-manager/commit/0ace9e780834d965958946bec14dc2b7001f5251

[annastuchlik]

@karol-kokoszka Thanks!

Are you a part of some docs team on github already ? I'm asking because I added you directly to this repo, but the best is to give access to documentation group if there is any.

I don't think there's such a group, and I'm not sure how to check it. It looks like I'm added to the repositories like any other contributor.

[dgarcia360]

@dgarcia360 one question, do you know why make docs replaces UTC with Europe/Warsaw ?

From the description, it appears that the default value is being retrieved from the system:

I believe that the default value might vary depending on the configuration of the computer running the make docs command.

[karol-kokoszka]

@gcarmin I just realized that the change you mentioned in the issue description is not in the repository at all. Backup examples HTML is generated out of this https://github.com/scylladb/scylla-manager/blob/branch-3.0/docs/source/backup/examples.rst

This file still keeps sctool backup -c prod-cluster -L 's3:my-backups' -s '2019-12-09T15:16:05Z' -i 24h

make docs didn't change the content of HTML ofc.

[annastuchlik]

@karol-kokoszka Is there anything you need from me to close this issue?

[annastuchlik]

@karol-kokoszka Please let me know if this issue can be closed.

[karol-kokoszka]

@annastuchlik the only thing needed here is to know what would you like to change in the documentation.

I've modified it to:

azureuser@gc-mng-mon-01:~$ sctool backup -L 'azure:scyllabackup' -s '2023-04-04T10:00:00Z' -i 1h Flag --start-date has been deprecated, use cron instead Flag --interval has been deprecated, use cron instead

I don't see 2023-04-04T10:00:00Z anywhere in the code.

github search in scylla-manager repository links to this issue only https://github.com/search?q=repo%3Ascylladb%2Fscylla-manager+%272023-04-04T10%3A00%3A00Z%27&type=issues

So, what do you want to change in the documentation. What is this issue about ?