Quick Start: Review entire quick start section when complete.

Description

Once the entire quick start section is done, review for flow, consistency, etc.

Guide is available here:

https://github.com/OpenNMS/opennms/tree/release-31.x/docs/modules/operation/pages/quick-start

Acceptance / Success Criteria

None

Attachments

1

Lucidchart Diagrams

Activity

Show:

Benjamin Reed November 16, 2022 at 2:47 PM

this got merged to release-31.x

Bonnie Robinson October 28, 2022 at 12:57 PM
Edited

Add missing link in the QS overview "Quick Start Contents" to the "Visualize your data" topic.

Bonnie Robinson October 27, 2022 at 8:39 PM
Edited

From WTD, callout errors (see screenshot).

 

Mike Huot October 27, 2022 at 8:34 PM
Edited

quick-start/users.html

Should we add to "We do not share it with third parties and we will not use it for sales purposes." or whatever.

BR: Have messaged A. Konsta to determine legal wording.

quick-start/notifications.html

-I think this is easier to use as a table –

 

Notification

on/off by default

High threshold

OFF

High threshold rearmed

OFF

Low threshold

OFF

Low threshold rearmed

OFF

interfaceDeleted

ON

interfaceDown

ON

etc

etc

BR: Agreed and done.

Configuring destination paths separately from{_}(should this be for? I always think of them for an event, might just be me){_} individual events lets you use the same information for multiple notifications.

BR: Done

Do we need to address delay interval in a quick start?

BR: Because the screen pops up as part of the process of configuring a destination path, we included it. Agree, that it's not necessary, and they haven't created a group either, so added text to skip this screen for the purpose of the QS guide.

We introduce UEI before we even talk about really what an event is. Maybe we should add the UEI to the above table to start to build some connection of UEI>Notification?-

BR: Removed reference to UEI, but added link to the events section which gives a broader definition of what an event is.

Should the multiple matches need to be here? I didn't even know about it! Maybe we can just drop that paragraph.

BR: Removed.

quick-start/inventory.html

Auto discovery is useful if you do not have a "source of truth" for your network inventory.
Maybe "Configure SNMP for provisioning" should be a separate step. I would include some kind of preface on why we need it for provisioning. The steps list make NO changes to the snmp-config.xml unless a community string is specified, instructions should include updating the Read Community String and Write Community String. If the defaults are acceptable of public/private, the configuration is not necessary.
Do we need to talk about a foreign source definition here? It isn't used in these steps and is hidden from the user at this point.

quick-start/performance-data.html

We probably need to cover SNMP v3 link to something for it here. The concerns around security for SNMP have continued to ramp up and I am guessing it will be used by anyone starting out new. David also talked(or will soon?) about SNMP's security, which v3 really addresses.

BR: added note about this as provided by Ronny.

Looks like we walk through setting a community string now. This should be collapsed in with the inventory.html steps.

BR: to be updated.

More later...maybe?

 

Bonnie Robinson October 27, 2022 at 6:52 PM
Edited

Added zip file and directions for feedback on Confluence for internal users who don't feel comfortable in GitHub. Requested feedback in the TOG channel.

https://confluence.internal.opennms.com/display/TD/Horizon+31+documentation%3A+Quick+Start+Guide

Fixed

Details

Assignee

Reporter

Doc Backlog Status

Components

Sprint

Fix versions

Affects versions

Priority

PagerDuty

Created September 1, 2022 at 5:47 PM
Updated November 16, 2022 at 2:47 PM
Resolved November 16, 2022 at 2:47 PM