Jira (PDB-2383) consider usage of "entity" in PDB documentation

3 views
Skip to first unread message

Wyatt Alt (JIRA)

unread,
Feb 3, 2016, 9:38:04 PM2/3/16
to puppe...@googlegroups.com
Wyatt Alt created an issue
 
PuppetDB / Task PDB-2383
consider usage of "entity" in PDB documentation
Issue Type: Task Task
Assignee: Unassigned
Created: 2016/02/03 6:37 PM
Priority: Normal Normal
Reporter: Wyatt Alt

This is mainly a placeholder ticket for a discussion that should take place. I'm not sure if it will result in action.

My concern is that our internal usage of the word "entity" is seeping into our docs (PQL particularly), and although it's standard terminology, I'm not convinced that our meaning will be clear to all users.

I think it might be worthwhile to add a docs page for PDB terms and definitions – entity is one thing that could go there, but I think this might also benefit some of the documentation around our facts storage model, which also exposes some internal language that users probably find confusing.

I also wonder if replacing "entity" with something like "datatype" might make things more clear. Up for discussion.

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

Zachary Kent (JIRA)

unread,
Nov 1, 2019, 1:46:03 PM11/1/19
to puppe...@googlegroups.com
Zachary Kent updated an issue
Change By: Zachary Kent
Labels: docs-pdb
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo
Reply all
Reply to author
Forward
0 new messages