dataforcanada/d4c-service-main-site
1
0
Fork 0
mirror of https://github.com/dataforcanada/d4c-service-main-site.git synced 2026-06-13 14:00:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

One of many changes to make today. Goal is to simplify, add videos, asciinema, jupyter notebooks, etc 😄

Browse Source
This commit is contained in:
Diego Ripley
2026-02-22 07:57:27 -05:00
parent 626efe9eac
commit 9d397ae714
2 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/docs/_index.md
+1 -1
View File
@@ -13,7 +13,7 @@ Look through our [GitHub Organization](https://github.com/orgs/dataforcanada/rep
{{< cards cols="2" >}} {{< cards cols="2" >}}
{{< card link="/docs/getting_started/file_naming_convention/" title="File Naming Convention" icon="cog" >}} {{< 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="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="/docs/d4c-pkgs/" title="Data for Canada Packages" icon="cube" >}}
{{< card link="/infrastructure/" title="Infrastructure" icon="office-building" >}} {{< card link="/infrastructure/" title="Infrastructure" icon="office-building" >}}
{{< /cards >}} {{< /cards >}}
content/docs/getting_started/file_naming_convention.md
+10 -7
View File
@@ -10,22 +10,26 @@ sidebar:
## Background ## Background
{{< callout type="important" >}} {{< callout type="info">}}
You will need to understand these concepts to fully grasp the file naming convention. You will need to understand these concepts to fully grasp the file naming convention.
{{< /callout >}} {{< /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. 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.
<!-- OK I can't get this to work, SO annoying-->
<!--{{% details title="https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/fig/index-eng.cfm?ID=F1_1" closed="true" %}}-->
![geographic hierarchy](geographic-hiearchy.svg). ![geographic hierarchy](geographic-hiearchy.svg).
<!--{{% /details %}}-->
### 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**. 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. We are open to feedback on the current file naming convention.
{{< /callout >}} {{< /callout >}}
{{% details title="File Naming Convention" closed="true" %}}
#### **Syntax** #### **Syntax**
`[iso-region]_[data-source-name]-[DGUID]_[data-pkg]_[iso-date]_[variant]_[version].[extension]` `[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` | | **5. Variant** | Resolution or specific subset info. | **No Projections.** Alphanumeric. Units included. | `075mm`, `30cm` |
| **_** | *Separator* | Underscore | | | **_** | *Separator* | Underscore | |
| **6. Version** | **Semantic Versioning**. | `v[Major].[Minor].[Patch]` | `v0.0.1` | | **6. Version** | **Semantic Versioning**. | `v[Major].[Minor].[Patch]` | `v0.0.1` |
{{% /details %}}
## 2. Component Detail ## 2. Component Detail
{{% details title="Details" closed="true" %}} {{% details title="Details" closed="true" %}}
### A. Source / Location ID (Flexible) ### A. Source / Location ID (Flexible)
This segment defines the "Who" of the dataset. This segment defines the "Who" of the dataset.