From 9d397ae71451413f90250eca22278fc59f64fb0b Mon Sep 17 00:00:00 2001 From: Diego Ripley Date: Sun, 22 Feb 2026 07:57:27 -0500 Subject: [PATCH] =?UTF-8?q?One=20of=20many=20changes=20to=20make=20today.?= =?UTF-8?q?=20Goal=20is=20to=20simplify,=20add=20videos,=20asciinema,=20ju?= =?UTF-8?q?pyter=20notebooks,=20etc=20=F0=9F=98=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/docs/_index.md | 2 +- .../getting_started/file_naming_convention.md | 17 ++++++++++------- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/content/docs/_index.md b/content/docs/_index.md index 5021fa9..ae81ba4 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -13,7 +13,7 @@ Look through our [GitHub Organization](https://github.com/orgs/dataforcanada/rep {{< cards cols="2" >}} {{< card link="/docs/getting_started/file_naming_convention/" title="File Naming Convention" icon="cog" >}} {{< card link="https://github.com/dataforcanada/d4c-community" title="Data for Canada Community" icon="chat" >}} - {{< card link="/docs/d4c-infra-distribution/" title="Data Dissemination Strategy" icon="globe" >}} + {{< card link="/docs/d4c-infra-distribution/" title="Data Dissemination Strategy" icon="lightning-bolt" >}} {{< card link="/docs/d4c-pkgs/" title="Data for Canada Packages" icon="cube" >}} {{< card link="/infrastructure/" title="Infrastructure" icon="office-building" >}} {{< /cards >}} diff --git a/content/docs/getting_started/file_naming_convention.md b/content/docs/getting_started/file_naming_convention.md index 5d21007..f714309 100644 --- a/content/docs/getting_started/file_naming_convention.md +++ b/content/docs/getting_started/file_naming_convention.md @@ -10,22 +10,26 @@ sidebar: ## Background -{{< callout type="important" >}} - You will need to understand these concepts to fully grasp the file naming convention. +{{< callout type="info">}} +You will need to understand these concepts to fully grasp the file naming convention. {{< /callout >}} See Statistics Canada's [geographic hiearchy](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/fig/index-eng.cfm?ID=F1_1) and use the [Census of Population 2021 Dictionary](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/index-eng.cfm) to understand their conceptual model of representing Canada. + + ![geographic hierarchy](geographic-hiearchy.svg). + -### 1. The Current Schema +## 1. The Current Schema All published datasets must adhere to the following structure to ensure files are machine-parsable, sortable by region, and identifiable by human readers. **This file naming convention will be modified as we solidify our processes**. -{{< callout >}} +{{< callout type="important">}} We are open to feedback on the current file naming convention. {{< /callout >}} +{{% details title="File Naming Convention" closed="true" %}} #### **Syntax** `[iso-region]_[data-source-name]-[DGUID]_[data-pkg]_[iso-date]_[variant]_[version].[extension]` @@ -48,13 +52,12 @@ We are open to feedback on the current file naming convention. | **5. Variant** | Resolution or specific subset info. | **No Projections.** Alphanumeric. Units included. | `075mm`, `30cm` | | **_** | *Separator* | Underscore | | | **6. Version** | **Semantic Versioning**. | `v[Major].[Minor].[Patch]` | `v0.0.1` | +{{% /details %}} ## 2. Component Detail + {{% details title="Details" closed="true" %}} - - - ### A. Source / Location ID (Flexible) This segment defines the "Who" of the dataset.