diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..938014c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +Closes #... + +- [ ] CHANGELOG.md updated +- [ ] Tests added (For bug fixes or new features) +- [ ] Documentation updated (if applicable) diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..e307108 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,5 @@ +# FAQ + +## Can I use dvc to track files that are outside the repository? + +Yes, this is possible by specifying an absolute path to that file. However, note that DVC will only _track_ but not _version_ that file. I.e. updating that files will invalidate the cache for `dvc repro`, but it will not be updated by `dvc pull` / `dvc checkout`. diff --git a/docs/index.md b/docs/index.md index 6bd95aa..bcdd835 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,15 @@ :caption: User Guide getting_started.md -user_guide/config_files.md +user_guide/templates.md +user_guide/params_files.md +user_guide/accessing_stage_configs.md +user_guide/dvc.md +user_guide/pre_commit.md +user_guide/uv.md +user_guide/linting.md +user_guide/quarto.md +faq.md ``` ```{toctree} diff --git a/docs/user_guide/accessing_stage_configs.md b/docs/user_guide/accessing_stage_configs.md new file mode 100644 index 0000000..b1582ae --- /dev/null +++ b/docs/user_guide/accessing_stage_configs.md @@ -0,0 +1,5 @@ +# Accessing stage config + +In this section we describe the rationale of `dso get-config`/`read_params` and detail how it works. + +TODO diff --git a/docs/user_guide/dvc.md b/docs/user_guide/dvc.md new file mode 100644 index 0000000..f976cda --- /dev/null +++ b/docs/user_guide/dvc.md @@ -0,0 +1,5 @@ +# DVC integration + +In this section we explain DVC, provide an overview how it works, links to the respective sections of the DVC documentation and how it is integrated with DSO. + +TODO diff --git a/docs/user_guide/linting.md b/docs/user_guide/linting.md new file mode 100644 index 0000000..fb94b7e --- /dev/null +++ b/docs/user_guide/linting.md @@ -0,0 +1,3 @@ +# Linting + +TODO diff --git a/docs/user_guide/config_files.md b/docs/user_guide/params_files.md similarity index 80% rename from docs/user_guide/config_files.md rename to docs/user_guide/params_files.md index a39a167..9e4bd0f 100644 --- a/docs/user_guide/config_files.md +++ b/docs/user_guide/params_files.md @@ -1,4 +1,6 @@ -# Configuration files +# Params files + +This section is the reference guide for configuration files. Explain inheritance, jinja 2 etc. in detail. TODO diff --git a/docs/user_guide/pre_commit.md b/docs/user_guide/pre_commit.md new file mode 100644 index 0000000..a59a073 --- /dev/null +++ b/docs/user_guide/pre_commit.md @@ -0,0 +1,5 @@ +# pre-commit integration + +Here we describe the pre-commit hooks used in DSO projects + +TODO diff --git a/docs/user_guide/quarto.md b/docs/user_guide/quarto.md new file mode 100644 index 0000000..130b4d8 --- /dev/null +++ b/docs/user_guide/quarto.md @@ -0,0 +1,5 @@ +# Quarto integration + +Here we describe how DSO integrates with quarto (`dso exec quarto`, watermarking, ...) + +TODO diff --git a/docs/user_guide/templates.md b/docs/user_guide/templates.md new file mode 100644 index 0000000..c52753a --- /dev/null +++ b/docs/user_guide/templates.md @@ -0,0 +1,3 @@ +# Project and stage templates + +TODO diff --git a/docs/user_guide/uv.md b/docs/user_guide/uv.md new file mode 100644 index 0000000..79720b4 --- /dev/null +++ b/docs/user_guide/uv.md @@ -0,0 +1,3 @@ +# `uv` integration + +TODO