Skip to content

Commit

Permalink
Create stub pages for user guide (#91)
Browse files Browse the repository at this point in the history
* Make getting started section more concise

* Update user guide

* Update getting started section

* Create stubs for user guide

* fix merge

* Add pull request template
  • Loading branch information
grst authored Jan 27, 2025
1 parent 09eaf78 commit f67c66b
Show file tree
Hide file tree
Showing 11 changed files with 51 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Closes #...

- [ ] CHANGELOG.md updated
- [ ] Tests added (For bug fixes or new features)
- [ ] Documentation updated (if applicable)
5 changes: 5 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -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`.
10 changes: 9 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
5 changes: 5 additions & 0 deletions docs/user_guide/accessing_stage_configs.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/user_guide/dvc.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions docs/user_guide/linting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Linting

TODO
Original file line number Diff line number Diff line change
@@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/user_guide/pre_commit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# pre-commit integration

Here we describe the pre-commit hooks used in DSO projects

TODO
5 changes: 5 additions & 0 deletions docs/user_guide/quarto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Quarto integration

Here we describe how DSO integrates with quarto (`dso exec quarto`, watermarking, ...)

TODO
3 changes: 3 additions & 0 deletions docs/user_guide/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Project and stage templates

TODO
3 changes: 3 additions & 0 deletions docs/user_guide/uv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `uv` integration

TODO

0 comments on commit f67c66b

Please sign in to comment.