From eb1727528e89132be75b6b33b68a2ccfb3eda8af Mon Sep 17 00:00:00 2001 From: Patelli Date: Thu, 26 Oct 2023 17:55:26 +0800 Subject: [PATCH 1/3] fix reST links --- docs_src/index.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs_src/index.rst b/docs_src/index.rst index cbf349b..bd43215 100644 --- a/docs_src/index.rst +++ b/docs_src/index.rst @@ -1,13 +1,12 @@ Welcome to SDMX Dashboard Generator's documentation! ==================================================== -The SDMX Dashboard Generator (SDMX-DG) is an open-source [Dash](https://dash.plotly.com) application that +The SDMX Dashboard Generator (SDMX-DG) is an open-source `Dash `_ application that generates dynamic dashboards by pulling data and metadata from SDMX Rest API. It supports the version 2.1 of the standard. It leverages the open-source library SDMXthon to retrieve and parse data and metadata in SDMX. Data and metadata are supported by asynchronous retrieval. A dashboard is composed of several visualizations as defined by the specifications provided in a .yaml file. The specifications are interpreted by a ChartGenerator -class containing instructions to define the Plotly charts. It has been developed for the -[SDMX Hackathon Global Conference 2023](https://www.sdmx2023.org/hackathon). +class containing instructions to define the Plotly charts. It has been developed for the `SDMX Hackathon Global Conference 2023 `_. .. image:: _static/light.png :width: 1338px From 4eeaaf8ff4a65377e7146d77a9c1a9a79a221b6e Mon Sep 17 00:00:00 2001 From: Patelli Date: Thu, 26 Oct 2023 17:57:18 +0800 Subject: [PATCH 2/3] update link to doc --- src/app.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/app.py b/src/app.py index 8476f8d..bb6ee87 100644 --- a/src/app.py +++ b/src/app.py @@ -37,7 +37,7 @@ dbc.icons.BOOTSTRAP, ] -DOC_LINK = "https://urban-memory-73nlz2m.pages.github.io" +DOC_LINK = "https://bis-med-it.github.io/SDMX-dashboard-generator" app = Dash( __name__, From b73a9150e6124833677990d26dc80527f7d689c1 Mon Sep 17 00:00:00 2001 From: Patelli Date: Thu, 26 Oct 2023 18:39:42 +0800 Subject: [PATCH 3/3] absolute links to material in repo --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e58c22..fd4e08a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We appreciate your interest in contributing. To ensure a smooth and productive c ## Licensing -Please note that the SDMX Dashboard Generator has a [License](LICENCE.pdf). By participating in this project, you acknowledge and accept to comply with it. +Please note that the SDMX Dashboard Generator has a [License](https://github.com/bis-med-it/SDMX-dashboard-generator/blob/main/LICENCE.pdf). By participating in this project, you acknowledge and accept to comply with it. ## How To Contribute @@ -29,7 +29,7 @@ If you find an issue to work on, you are welcome to open a PR with a fix. ### Pull Requests -We cordially invite you to use our [pull request template](/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md). +We cordially invite you to use our [pull request template](https://github.com/bis-med-it/SDMX-dashboard-generator/blob/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md). You may open a pull request to: