[DOCS-14202] Include helpful IP address information Created: 08/Feb/21  Updated: 30/Oct/23

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Minor - P4
Reporter: Eric Sedor Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-54400 Identify source of failing config in ... Closed
Participants:
Days since reply: 1 year, 14 weeks, 2 days ago
Epic Link: DOCSP-11702

 Description   

Description

To help users respond to an "Invalid IP address in CIDR string" message, we could provide some guidance about what to look for. Somewhere the user has provided an invalid IP address. A few considerations:

  • It is not feasible for us document all the ways an IP address can be "wrong"
  • Linking directly to RFCs that specify IPs isn't very friendly/

We do document some relevant IP address information in our meta-documentation here. However:

  • The audience for meta-documentation is not MongoDB users/customers.
  • As the warnings on that page make clear, we should not accidentally suggest specific configuration values to users

This goal of this ticket should be to:
1) Craft something like the referenced meta-documentation page, which links to RFCs while also providing some examples/guidance
2) Identify where to best place this in our product documentation
3) Reference that page from documentation for parameters and config that accept IP addresses

Once this is complete, it would be feasible to include the produced docs in error messages or support communications.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Education Bot [ 31/Oct/22 ]

Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!

Generated at Thu Feb 08 08:09:46 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.