Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.87 KB

README.md

File metadata and controls

89 lines (65 loc) · 2.87 KB
Raw

TU logo

Data Sources Quarto Site

This repository contains the source files for a Quarto website that provides an overview of data sources that can be used on TU projects.

Table of Contents

  1. Purpose
  2. Repository Structure
  3. Getting Started
  4. Raising Issues
  5. Contributors

1. Purpose

This website has been built, and is still being developed in Quarto with the aim of documenting important sources of data that we use on our projects. Beyond documenting data sources the website is also designed to educate others within the team on the data sources that can be used on projects, how to explore these and what they can be helpful for.

2. Repository Structure

The repository is structured as:


data-sources/
├── .git/
├── .gitignore
├── _quarto.yml
├── index.qmd
├── pages/
    ├── topic1.qmd
    ├── topic1_a.qmd
    ├── topic1_b.qmd
    ├── topic2.qmd
    ├── topic2_a.qmd
    ├── topic2_b.qmd
    └── ...
├── images/
├── tu_theme.css
├── docs/
└── README.md
  • _quarto.yml: Configuration file for Quarto, specifying website structure and settings.
  • index.qmd: The homepage content.
  • pages/: Contains individual .qmd files for each of the topics and data sources documented in the website.
  • images/: Stores images used within the website.
  • tu_theme.css: Contains the custom .css file for TU formatting.
  • docs/: The output directory for rendered HTML files. These are then used by GitHub Pages to host the website.

3. Getting Started

To clone this repository and set-up the project locally:

  1. Clone the repository:
git clone https://github.com/NHS-Transformation-Unit/data_sources.git
  1. Navigate into the directory:
cd data_sources

  1. Install Quarto: If not already completed then install Quarto or ensure that it is accessible via your IDE of choice.

  2. Render website locally:

For example within R, run:

quarto::quarto_render()
  1. Preview the site:

Open the HTML files in the docs/ folder to view the website locally.

4. Raising Issues

If you are raising an issue due to a bug or for adding a missing data source then please follow these guidelines:

  • Title: Clearly and concisely describe the issue.
  • Labels: Add the relevant label (e.g. bug, enhancement, etc.) to help the issue be appropriately categorised.
  • Description: Provide a clear description of the issue including screenshots if necessary.
  • Steps to reproduce: If reporting a bug, please outline the steps to reproduce the issue.

5. Contributors