[DOCS-5528] Automation Agent Cluster Config IA Improvements Created: 02/Jun/15  Updated: 11/Jan/17  Resolved: 27/Jul/16

Status: Closed
Project: Documentation
Component/s: Cloud Manager, Ops Manager
Affects Version/s: None
Fix Version/s: 01112017-cleanup

Type: Task Priority: Major - P3
Reporter: Sam Kleinman (Inactive) Assignee: Anthony Sansone (Inactive)
Resolution: Won't Fix Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 7 years, 29 weeks ago
Epic Link: docs-automation-agent

 Description   

I was attempting to write a program to generate automation agent cluster configuration files, and stumbled through the current reference page, and I think it warrants some general usability improvements:

  • sections should be smaller, in general any unuque object/document should have it's own section.
  • the use of hyphens to indicate nesting is a bit confusing, and isn't necessarily great for all display situations.
  • names of fields should be in monospaced font and cross refrence-able.
  • we should call mapping structures documents, just to match global styles. Object is not an incorrect type identifier, but given situations where "everything's an object," it feels confusing.
  • it might be time to split the page in to multiple pages.

It may also be useful to have a page that is only a prototypical document, and document fields separately. I also think that because there's a lot of information here, and a lot of potential ways people might want to access it, it might make sense to store the data in some abstract format and then generate several possible outputs. The MongoDB documentation (on the whole) has a lot of reference documentation of JSON-like objects (serverStatus springs to mind) and I think a multi-output solution might be more generally useful.



 Comments   
Comment by Emily Hall [ 27/Jul/16 ]

Closed for housekeeping on 7/27/2016 by Emily Hall.
If you require additional support, please open a new ticket for prioritization.
Thanks,
Emily

Generated at Thu Feb 08 07:50:29 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.