Jira (PDB-2326) PQL: For docs, split out model from endpoints into a single doc

[Kenneth Barber (JIRA)]

Kenneth Barber created an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc Issue Type: Task Assignee: Unassigned Created: 2016/01/19 6:02 AM Fix Versions: PDB 4.0.0 Priority: Normal Reporter: Kenneth Barber Right now all the model information about entities, such as fields and such are kept in the various endpoint documents. This isn't as accessible as I'd like it to be for the purposes of PQL. We should take the model documentation out of the endpoints, and instead extend entities.markdown/html to include all model information for all entities. Endpoint docs can then reference those pages. Other ideas maybe we squash the endpoints into 1 doc perhaps, now the model information is on its own? the model is going to be fairly repetitive, we should consider using the Liquid templating that is provided on the docs website, to format information on the model from data. The data itself can be stored in the front-matter (the little bit of YAML at the top of each file) of the markdown for now, until we can extract it from the engine automatically perhaps. in the future obviously, it would be lovely to generate this model documentation automatically from the query engines information about the model. Add Comment

This message was sent by Atlassian JIRA (v6.4.12#64027-sha1:e3691cc)

[Ryan Senior (JIRA)]

Ryan Senior updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Ryan Senior Sprint: PuppetDB 2016- 02 03 - 10 09

Add Comment

[Susan McNerney (JIRA)]

Susan McNerney updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Susan McNerney Scrum Team: PuppetDB

Add Comment

[Kenneth Barber (JIRA)]

Kenneth Barber updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Kenneth Barber Sprint: PuppetDB 2016- 03 04 - 23 06

Add Comment

[Kenneth Barber (JIRA)]

Kenneth Barber updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Kenneth Barber Story Points: 2 5

Add Comment

This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9)

[Kenneth Barber (JIRA)]

Kenneth Barber updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Kenneth Barber Sprint: PuppetDB 2016-04- 06 20

Add Comment

[Susan McNerney (JIRA)]

Susan McNerney updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Susan McNerney Sprint: PuppetDB 2016- 05- 04 -20

Add Comment

[Ryan Senior (JIRA)]

Ryan Senior updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Ryan Senior Sprint: PuppetDB 2016-04-20 Hopper

Add Comment

[Ryan Senior (JIRA)]

Ryan Senior updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Ryan Senior Fix Version/s: PDB 4.1.0 Fix Version/s: PDB 4.2.0

Add Comment

[Ryan Senior (JIRA)]

Ryan Senior updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Ryan Senior Sprint: Hopper

Add Comment

[Ryan Senior (JIRA)]

Ryan Senior updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Ryan Senior Fix Version/s: PDB 4.2.0

Add Comment

[Austin Blatt (Jira)]

Austin Blatt updated an issue

PuppetDB / PDB-2326 PQL: For docs, split out model from endpoints into a single doc

Change By: Austin Blatt Labels: docs-pdb query-engine-improvements

Add Comment

This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)