From ce1afff299912dec5d18c8987fb93c1c9bc266c7 Mon Sep 17 00:00:00 2001 From: Koen Leuveld Date: Tue, 17 Oct 2023 09:06:15 +0200 Subject: [PATCH] add readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c646e6d --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Introduction + +This repository contains draft versions of the RDM pages of the Faculty of Social Sciences of the Vrije Universiteit Amsterdam. The purpose is to have an environment to quickly draft and view new or updated pages. The finished pages are published on VU.nl manually by the university's communication department. + +The rendered pages can be viewed on https://vu-fss.github.io/RDM + +# How to update + +The faculty data steward owns the repository and can make updates. It's best to make updates first to the updates branch, and render them locally using bookdown-serve() or bookdown-render(). All updates to the main branch are published to the site using github actions using the procedure outlined +[here](https://medium.com/@delucmat/how-to-publish-bookdown-projects-with-github-actions-on-github-pages-6e6aecc7331e). + +# Folder structure + +- .github: contains the information for github actions. +- _documents: folder containing documents for an old version of the website. +- assets: contains files needed for the site +- outputs (ignored by git): folder created by bookdown-serve() or bookdown-render() for the local version of the website. It is ignored because it is entirely built off index.rmd and the files in the pages folder. +- pages: the various pages (bookdown chapters). +- presentations: a folder containing slides for previous presentations. Should probably be moved to assets. +- sample_dmps: contains sample dmps for the data organization page; could probably be moved to assets. +