Closed dgarcia360 closed 2 months ago
@annastuchlik please review
Even though it's empty, check that it works and we will add content after the merge
LGTM @tarzanek @julienrf Please merge this PR and configure GitHub pages (as shown in the description of this PR).
Background: We want to create and publish documentation for Scylla Migration in the same way as we do for all other Scylla projects. This PR adds the required components, such as the necessary folder structure (docs, source, utils), a Makefile to build the docs with Sphinx, the workflows to build the docs and PRs, a list of dependencies, etc.
Once it's done, we will be able to add content to the docs folder and publish it on https://migrator.docs.scylladb.com.
@dgarcia360 what custom subdomain will be needed in Pages?
ah, okay, so I read @annastuchlik comment and subdomain will be migrator.docs.scylladb.com I configured it and triggered a build
there was one more option that picked workflow, but I assume it will be picked up after merge automagically
Motivation
Adds a sample docs site to the project.
How to test
cd docs
make preview
Next steps after merging
Configure GitHub Pages (maintainers)
Could you please enable the following option?