sdmp / sdmp.github.io

The main front-page and docs for the sdmp project.
https://sdmp.io
2 stars 2 forks source link

Question: General Information Storage #6

Closed jmhobbs closed 9 years ago

jmhobbs commented 9 years ago

In the general information section of the resources page, it states:

For general visible content, the sdmp object in the resource’s 
YAML document has the following reserved properties:

sdmp.document (object)

However, in the examples, there is a public blog post where the general public data is defined in the main YAML body, instead of in sdmp.document


---
sdmp:
    version: 0.9
    publisher: 7a5179eecc0fe18760ba615f92603372ae3fe302860098a019e15927551fee3b
    created: 2015-04-23
blog:
    author:
        name: John Doe
        hash: 7a5179eecc0fe18760ba615f92603372ae3fe302860098a019e15927551fee3b
    data: |
        This is an imagined *markdown* formatted thing, like a blog post or whatnot.
...

Is this a valid document? Is placing the content on sdmp.document optional?

saibotsivad commented 9 years ago

Oh my, I forgot to update the examples! I'll get on that Monday night.

On June 22, 2015 12:48:26 AM CDT, John Hobbs notifications@github.com wrote:

In the general information section of the resources page, it states:

For general visible content, the sdmp object in the resource’s 
YAML document has the following reserved properties:

sdmp.document (object)

However, in the http://sdmp.github.io/docs/resources/#examples, there is a public blog post where the general public data is defined in the main YAML body, instead of in sdmp.document

---
sdmp:
  version: 0.9
  publisher:
7a5179eecc0fe18760ba615f92603372ae3fe302860098a019e15927551fee3b
  created: 2015-04-23
blog:
  author:
      name: John Doe
      hash:
7a5179eecc0fe18760ba615f92603372ae3fe302860098a019e15927551fee3b
  data: |
      This is an imagined *markdown* formatted thing, like a blog post or
whatnot.
...

Is this a valid document? Is placing the content on sdmp.document optional?


Reply to this email directly or view it on GitHub: https://github.com/sdmp/sdmp.github.io/issues/6

Sent from my Android device with K-9 Mail. Please excuse my brevity.

jmhobbs commented 9 years ago

So it should be under sdmp then? Just checking.

---
sdmp:
    version: 0.9
    publisher: 7a5179eecc0fe18760ba615f92603372ae3fe302860098a019e15927551fee3b
    created: 2015-04-23
    document:
        blog:
            author:
                name: John Doe
                hash: 7a5179eecc0fe18760ba615f92603372ae3fe302860098a019e15927551fee3b
            data: |
                This is an imagined *markdown* formatted thing, like a blog post or whatnot.
...

If thats the case I'd be happy to update the examples and do a PR

saibotsivad commented 9 years ago

I read through the docs to make sure, and I think the "General Information" section needs a bit of rethinking. This is related to your question about some sort of type property: I wanted people to be able to extend the resource and not need to put everything they wanted to add under the sdmp property, so I put the blog property outside of it. I'll think about it this afternoon, and update it tonight.

jmhobbs commented 9 years ago

Thanks!

saibotsivad commented 9 years ago

Just a note to myself that this issue is related to https://github.com/sdmp/sdmp.github.io/issues/7