scylladb / scylla-cloud-getting-started

https://cloud-getting-started.scylladb.com
43 stars 11 forks source link

Add a documention theme #3

Closed tzach closed 1 year ago

tzach commented 1 year ago

see https://sphinx-theme.scylladb.com/ for instructions

tzach commented 1 year ago

cloud-geeting-started.scylladb.com

tzach commented 1 year ago

@annastuchlik please advice

annastuchlik commented 1 year ago

@DanielHe4rt The documentation should be published to http://cloud-getting-started.scylladb.com/. It has been added to our DNS, so you can proceed with the updates to this repository.

You should install the documentation theme following the installation guide at https://sphinx-theme.scylladb.com/stable/getting-started/installation.html. The same guide was followed to create the recent Feature Store Example documentation, so you can see the project structure and configuration as an example: https://github.com/scylladb/scylladb-feature-store/tree/master/docs

Should you need assistance, please contact David Garcia @dgarcia360 to schedule a meeting where you can set up the configuration together.

Let me know if you have any questions

DanielHe4rt commented 1 year ago

Hey @annastuchlik! I did the full setup described at the documentation but at the DNS page it shows up trying validate the domain.

image

Also I'm getting an error on make multiversion command. cc: @dgarcia360

image

annastuchlik commented 1 year ago

Hi Daniel,

Please use make preview to run a local preview. I was able to run a local preview (and I'm going to open a few issues as a follow-up).

When did you try to publish the docs? It may take 24h for the changes to propagate. If it still doesn't work, please contact @dgarcia360 (you can find him on the User Slack).

DanielHe4rt commented 1 year ago

I published has a few days already. I think that has something with the DNS and I mailed Boris about that.

annastuchlik commented 1 year ago

It looks like https://cloud-getting-started.scylladb.com/stable/ is up and the Sphinx theme is applied. However, the problems reported in https://github.com/scylladb/scylla-cloud-getting-started/issues/11 make some sections impossible to use.

DanielHe4rt commented 1 year ago

Closing the issue since it's already deployed.