Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: enhancing "using docker" section #2294

Open
DanielHe4rt opened this issue May 20, 2024 · 8 comments
Open

docs: enhancing "using docker" section #2294

DanielHe4rt opened this issue May 20, 2024 · 8 comments
Labels
documentation Documentation related

Comments

@DanielHe4rt
Copy link

Hey folks, how y'all doing? I would like to ask for an enhancement in the next versions of the docker-compose page.

Motivation

Recently I delve into Scylla Monitoring and I still think that is missing some information related to "versioning" in commands, more variety of commands or even updated versions.

image

When I saw the "-v 2020.1" I thought "ok, maybe we stopped in this version." but seems to be other ones. And where can I find this other versions from Open Source and Enterprise?

Suggest a fix

I'd like to keep track on the latest stable versions in the docs or even using Sphinx Variables to populate this for us like a flag. Something like:


Grafana Dashboard Load file

To set the dashboard load file, you can run the ./generate-dashboards.sh with the -t command line flag and the -v flag to specify the version:

# Open Source Dashboard
./generate-dashboards.sh -t -v 6.0

# Enterprise Dashboard
./generate-dashboards.sh -t -v 2024.1

This command generates the files under: grafana/provisioning/dashboards/ and you can find the supported versions here;


@mykaul mykaul added the documentation Documentation related label May 21, 2024
@mykaul
Copy link
Contributor

mykaul commented May 21, 2024

@DanielHe4rt
Copy link
Author

Yeah! The goal is to make sure that we will have easy forwarding when someone needs a specific information about versioning.

@mykaul
Copy link
Contributor

mykaul commented Jun 18, 2024

@DanielHe4rt - so I'm unsure - what's missing?

@amnonh
Copy link
Collaborator

amnonh commented Jul 2, 2024

@tzach we have a file with all the parameters, is there a way to pull those parameters from there and propagate them?

@tzach
Copy link
Contributor

tzach commented Jul 2, 2024

For sure there is a way, not sure its worth the effort...
Where is this file?

@amnonh
Copy link
Collaborator

amnonh commented Jul 2, 2024

it's called versions.sh in the root directory of the project

@tzach
Copy link
Contributor

tzach commented Jul 2, 2024

I'm not sure publishing https://github.com/scylladb/scylla-monitoring/blob/master/versions.sh will be useful.
Can you add description to each?
We can also link to this file, it is public.

@amnonh
Copy link
Collaborator

amnonh commented Jul 2, 2024

@tzach this is definitely not what I suggest, I would like the Python script to read the file and use that information inside the docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related
Projects
None yet
Development

No branches or pull requests

4 participants