[DOCS-8780] Doc design truncates code examples Created: 07/Sep/16  Updated: 25/Jan/17  Resolved: 25/Jan/17

Status: Closed
Project: Documentation
Component/s: Atlas, Cloud Manager, Ops Manager
Affects Version/s: None
Fix Version/s: post-launch_mongodb-3.4

Type: Bug Priority: Major - P3
Reporter: Shlomo Greenbaum Assignee: Andrew Aldridge
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File Screen Shot 2016-09-07 at 9.39.36 AM.png    
Participants:
Days since reply: 7 years, 3 weeks ago
Epic Link: DOCSP-269
Story Points: 1

 Description   

In all the examples, the URL is truncated



 Comments   
Comment by Kay Kim (Inactive) [ 25/Jan/17 ]

Have a project in the works to add copy button to all code blocks, which should alleviate this problem.

Comment by Bob Grabar [ 07/Sep/16 ]

Thanks! Yeah, it breaks so cleanly on /v1.0/group it looks like the end of the line. Adding a note is a good idea. We'll also consider maybe reformatting in some way.

I'm attaching a screenshot.

Comment by Shlomo Greenbaum [ 07/Sep/16 ]

Here is the URL:

https://docs.opsmanager.mongodb.com/current/reference/api/alerts/

Within that page, in the section "Examples", the first example is "Get an Alert" and the example given is:

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/group

However, while providing the information in this comment I noticed that if I continue highlighting the above line, I eventually do see the entire (untruncated) line, which is:

curl -u "username:apiKey" --digest -i "https://cloud.mongodb.com/api/public/v1.0/groups/5196d3628d022db4cbc26d9e/alerts/533cb4b8e4b0f1820cdabc7f"

Bottom line: Maybe this requires only an explanation about the apparent truncation and how to get around it, to avoid confusion.

Thanks.

Comment by Bob Grabar [ 07/Sep/16 ]

sgreenba@cisco.com Can you send the URL for the page(s) you're looking at?

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