Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Merge User and Admin Guide

Description

We have split up the documentation in three roles:

  • User

  • Administrator

  • Developer

The split between user and administrators is adding confusion, overhead and make things harder to find.

Confusion

The meaning of User and Administrator in OpenNMS world is to overloaded with the meaning in the domain it is used. An Administrator, in general, is a person who operates a computer network and "uses" OpenNMS. An Administrator in OpenNMS is a specific user who just configures OpenNMS to solve specific monitoring requirements. A user in generic terms, on the other hand, is someone who is working with the computer network whereas a "User" in OpenNMS terms is someone working in a NOC and just uses the monitoring functionalities provided by an OpenNMS Administrator.
In most cases, the OpenNMS Administrator and OpenNMS User is the same person and this makes it hard to distinguish. To make things easier for our users both guides should be merged into one. This makes it also harder for people to contribute to documentation cause the target group is fuzzy and makes things error-prone, see Configuration sections in the User guide which are clearly need to be in the Admin Guide

It is hard to identify topics to place in one or another / both, e.g. http://docs.opennms.org/opennms/releases/22.0.0/guide-user/#_creating_views_for_users_and_groups

Overhead

We have to duplicate introduction content for similar topics and need write them in a slightly different way for the target group.

Search

For the reasons mentioned in the topic addressing confusion, it is harder to find things cause they are split up into two parts.

Acceptance

User guide removed from Maven modules
Remove guide-user when installed from RPM Package
Remove guide-user when installed from DEB Package
Remove link when published to docs.opennms.org
Remove link guide-user in the Web UI in "Admin -> Help"

Acceptance / Success Criteria

None

Lucidchart Diagrams

Activity

Show:

Marcel Fuhrmann March 30, 2020 at 7:43 PM

Since we don't have a user guide here anymore: http://docs.opennms.org/opennms/releases/25.2.1/guide-admin/guide-admin.html#ga-notifications
It looks like the issue can be closed. Feel free to reopen if required.

Ronny Trommer July 2, 2018 at 6:52 AM

Merged PR in develop

Benjamin Reed June 29, 2018 at 5:58 PM

Holy crap!

 

http://docs.projectatomic.io/container-best-practices/#_removing_documentation

 

This is expected behavior; yum on docker centos is, by default, configured to not install docs.  Remove tsflags=nodocs from /etc/yum.conf.

 

Benjamin Reed June 29, 2018 at 2:58 PM

So this is really freakin' weird.  When I run rpm under strace, it appropriately makes directories and then {{open()}}s files to write them:

 

In yum, it does this instead:

 

There's something weird going on where it gets a TTY error despite us running docker with a TTY (the t in docker run -it).

Ronny Trommer June 15, 2018 at 2:17 AM

Tested the Debian packages and they look fine.

Fixed

Details

Assignee

Reporter

Labels

Components

Sprint

Fix versions

Priority

Parent

PagerDuty

Created May 30, 2018 at 7:26 AM
Updated March 30, 2020 at 7:43 PM
Resolved July 2, 2018 at 6:52 AM