cygri / void

An RDF schema and associated documentation for expressing metadata about RDF datasets
http://www.w3.org/TR/void/
15 stars 1 forks source link

Restructuring the voiD Guide #83

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
This is a proposal to re-structure the document. The content has changed quite 
a bit since Guide 1, and it's time to rethink the overall structure.

I propose the following structure. This only requires a bit of new text in 
Section 5, otherwise it's just a matter of pushing existing text around:

1. Introduction
1.1 Scope
1.2 Definition: Datasets
1.3 Definition: Linksets (note: includes LOD vs 3rd party etc)
1.4 Document conventions

2. General dataset metadata
2.1 Basic Dublin Core metadata
2.2 Announcing the license of a dataset
2.3 Categorizing datasets

3. Access metadata
3.1 Example resources
3.2 SPARQL endpoint
3.3 RDF data dumps
3.4 URI lookup and OpenSearch endpoints
3.5 Technical Description (Features)

4. Structural metadata
4.1 Patterns for resource URIs
4.2 Vocabularies used in a dataset
4.3 Describing partitioned datasets
4.4 Partitioning datasets based on classes and properties
4.5 Describing linksets
4.6 Statistics about datasets and linksets

5. Deploying voiD descriptions
5.1 Choosing URIs for datasets (note: includes homepage smushing)
5.2 Publishing a voiD file alongside a dataset
5.3 Describing individual RDF documents that are part of a dataset
5.4 Describing RDF dumps
5.5 Using voiD wtih the SPARQL Service Description Vocabulary

6. Discovering voiD descriptions
5.1 Discovery via links in the dataset's documents
5.2 Discovery via sitemap.xml
5.3 Discovery via .well-known

7. Cheat sheet

8. Acknowledgements

References

Original issue reported on code.google.com by richard....@gmail.com on 22 Nov 2010 at 4:22

GoogleCodeExporter commented 9 years ago
+1 to do it (and also to do it NOW, that is change this to MS 2)

Original comment by Michael.Hausenblas on 25 Nov 2010 at 8:17

GoogleCodeExporter commented 9 years ago
Decided to do this for release 2.0 in today's teleconference

Original comment by richard....@gmail.com on 7 Dec 2010 at 12:02

GoogleCodeExporter commented 9 years ago
Done as per r161, although with a slightly different final outline. Results are 
here:
http://void-impl.googlecode.com/svn/trunk/guide2/index.html

Some sections have undergone major changes and some are all new:

- 1. Introduction has major changes
- 2.1 Web page links is new
- 4.6 Providing statistics about datasets has major changes to structure
- 5. Describing linksets has major changes
- 6.1 Choosing URIs for datasets is new
- 6.3 Multi-document datasets and backlinks has major changes
- 6.4 Describing RDF dumps is new

I also applied the W3C stylesheet, did some other layout work, cleaned up the 
HTML sources, made sure that the HTML validates, made sure that all Turtle is 
syntactically correct, and made sure that all prefixes are defined. We're 
getting there…!

Original comment by richard....@gmail.com on 8 Dec 2010 at 7:28

GoogleCodeExporter commented 9 years ago
Close as per today's teleconference

Original comment by richard....@gmail.com on 14 Dec 2010 at 11:56