Skip to content

Commit

Permalink
Update getting-started.Md
Browse files Browse the repository at this point in the history
Merge in content from previous outline, at top-level of book directory
  • Loading branch information
pbuttigieg authored Feb 2, 2024
1 parent 5a6cb0d commit 4ea93d5
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions book/getting-started/getting-started.Md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# Getting started with ODIS
# Getting started with ODIS: How to join the ODIS Federation

## Hello world

This page describes - at a high level - how a digital system with access to the Web can link itself into the ODIS Federation.

Any system providing data (in a broad sense, including documents, software code, etc) and/or services that are relevant to ocean science, management, policy, commerce, or other ocean-relevant activities is welcome to connect to ODIS. A light curation of ODIS nodes is performed by IODE's team, and the entire Federation self-regulates, voicing concern if they believe nodes.
Any system providing data (in a broad sense, including documents, software code, etc) and/or services that are relevant to ocean science, management, policy, commerce, or other ocean-relevant activities is welcome to connect to ODIS. A light curation of ODIS nodes is performed by IODE's team, and the entire Federation self-regulates, voicing concern if they believe nodes are sharing data that is invalid, misleading, or otherwise of concern.

## Background

In an increasingly data-driven digital landscape, sharing information about your resources on the web has become a vital endeavor. Structured data, presented through JSON-LD, offers an approachable means to achieve this goal, providing context and linked data in a format easily understood by both humans and machines. Through the incorporation of schema.org, a collaborative initiative designed to create, maintain, and promote schemas for structured data on the internet, this guide will help you navigate the process of sharing JSON-LD for your web resources. In this guide, we'll walk you through the key steps to effectively share JSON-LD on the web for your resource, empowering you to enhance discoverability and semantic context for your valuable content.

The importance of sharing (meta)data about your digital assets - in a form that others can understand - cannot be underemphasised: wihout a common approach, digital assets are often invisible to one another, harming collaboration, due diligence, and informed action. The IODE ... [TODO: state IODE's role in the ocean space]

TODO:Link off to docs about JSON-LD, schema.org, and structured data on the web


## Registering your organisation
Expand Down Expand Up @@ -78,7 +86,31 @@ Add metadata on how often you expect records in your sitemap to change - this wi
## Coming full circle: registering your sitemap in ODISCat


**Section 3: Steps to Share JSON-LD**
1) Explain the key steps to share JSON-LD for your resource:
1) **Authoring JSON-LD Documents:**
- Discuss the process of creating JSON-LD documents aligned with project guidelines.
1) **Inserting JSON-LD into Web Pages:**
- Describe how to embed JSON-LD into web pages using SCRIPT tags.
1) **Including JSON-LD in Sitemaps:**
- Explain the importance of adding JSON-LD marked resources to XML sitemap files.
1) **Validation and Iteration:**
- Discuss the use of validation tools to ensure well-formed JSON-LD.
- Emphasize the iterative nature of aligning JSON-LD as the project profile evolves.

**Section 4: Conclusion**
1) Summarize the essential steps for sharing JSON-LD on the web.
1) Encourage readers to start implementing structured data for their resources.
1) Provide a closing thought or encouragement for users to explore further.


### 1.1

**Defining Structured Data and JSON-LD:** Structured data is the practice of organizing and presenting data on the web in a way that provides clear context and relationships between different pieces of information. JSON-LD, which stands for JSON for Linked Data, is a popular format for expressing structured data using JSON syntax. It allows you to create machine-readable content that can be easily understood by search engines, making it an effective method for enhancing the visibility and comprehensibility of your web resources.

### 1.2

**The Role of Schema.org and the FAIR Principles:** Schema.org, a collaborative initiative, plays a crucial role in the structured data landscape. It is closely aligned with the FAIR (Findable, Accessible, Interoperable, Reusable) principles, which aim to improve the accessibility and usability of data. By using schema.org, you're not only making your data more findable but also contributing to its accessibility and interoperability. This means that your structured data becomes more reusable by other systems, researchers, and organizations, reinforcing the FAIR principles and promoting a global data-sharing ecosystem. In this guide, we will show you how to leverage these concepts to efficiently share your JSON-LD data on the web.



0 comments on commit 4ea93d5

Please sign in to comment.