You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-4Lines changed: 27 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,8 +35,31 @@ The relevant sections can be found by the same name in the folder structure:
35
35
└── tutorials/ <----
36
36
```
37
37
38
-
## How to update these docs
38
+
## Updating the docs
39
39
40
-
A GitHub pages site is build from the `docs/` folder in the `main` branch.
41
-
To see your local changes appear on the live site, you need to run `quarto render` first.
42
-
This command updates the docs/ folder with your changes.
40
+
### Issue
41
+
42
+
Originally, the [blockr](github.com/BristolMyersSquibb/blockr) package repository contained quarto documentation in a `site/` subfolder which was then published to gh pages to serve the user-facing documentation.
43
+
Since then, the user-facing documentation has been rewritten into this repo as a new quarto project, starting from scratch.
44
+
This strategy was decided in order to keep the user-facing documentation separate from the blockr R package developer-facing documentation.
45
+
This allows for both ease of maintenance and clearer spearation of concerns.
46
+
Consequently, there is still a need for the documentation in this repository to build and point to the original gh pages url slug `/blockr` and not `/blockr-site`, to maintain continuity.
47
+
48
+
### Solution
49
+
50
+
Any pushes to main in this repo trigger the `.github/workflows/trigger-deploy.yml` workflow.
51
+
This workflow then sends a dispatch event to the blockr repo which tiggers its own [deploy-site](https://github.com/BristolMyersSquibb/blockr/blob/main/.github/workflows/deploy-site.yaml) workflow.
52
+
The deploy-site workflow then checks out this `blockr-site` repo, renders the docs, uploads them as a GitHub Pages artifact, and then finally deploys the site.
53
+
54
+
### How-to
55
+
56
+
Simply run `quarto render` to update and build the `docs/` folder (containing the assets for the live site) and the push your changes to `main`.
57
+
Your changes should be reflected in the blockr repo gh pages accessible via [https://bristolmyerssquibb.github.io/blockr/]()
58
+
59
+
If you want to manually trigger the `deploy-site` workflow in blockr, you can run:
60
+
61
+
```bash
62
+
gh api repos/BristolMyersSquibb/blockr/dispatches \
0 commit comments