Bug 1413712

Summary: [DOCS] More information on possible annotations for projects and other OCP objects
Product: OpenShift Container Platform Reporter: Steven Walter <stwalter>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: low    
Version: 3.3.0CC: aos-bugs, gnelson, jokerman, mmccomas, sjr
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-04-26 13:29:17 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Steven Walter 2017-01-16 18:39:32 UTC 
Document URL: 
https://docs.openshift.com/container-platform/latest/rest_api/openshift_v1.html

Section Number and Name: 

v1-objectmeta, v1-project, create-a-project, et cetera

Describe the issue: 
Our api documentation does not provide a list of annotations or metadata that can be used. For instance, OpenShift projects have:

annotations["openshift.io/description"] 
annotations["openshift.io/display-name"]
annotations["openshift.io/node-selector"]

Suggestions for improvement: 

THis issue is not necessarily limited to projects; other objects which can take useful metadata/annotations are not always extensively documented here. Customers can resort to running an `oc` command with --loglevel=9 to get information on commands, but this is not great for usability.


Additional information: 
See:
https://trello.com/c/pkW3DkIw/746-5-better-distribution-of-templates-examples-evg
Comment 6 Gaurav Nelson 2018-04-26 13:29:17 UTC 
The related card and the case says this one is completed, so i am closing this one.