# OpenNMS - DevJam 2018 - HackPAD!
:::danger
This pad is accessible by anyone who has the address to this pad, if you used an obvious name for the pad, it could be guessed.
WARNING: This pad will be DELETED if 30 days go by with no edits. There is NO WAY to recover the pad after this happens, so be careful!
:::
People attending DevJam have created a high level project proposals in our [DevJam 2018 wiki page](https://wiki.opennms.org/wiki/Dev-Jam_2018).
The event runs in a barcamp style and topics discussed. You can view and add topics on our [Pinwall](http://bit.ly/devjam2018-pinwall).
If you don't know how this pad works, follow [this link](https://hackmd.io/features?both) with examples.
## Structure Ideas
* [Mark Mahacek](https://hackmd.io/B5y5ihPfQ9G2UvKJPC3DMg?view)
* [Ronny](https://hackmd.io/rB38Uo6hQNiDwF07HRs2RQ?both)
* [Alejandro](https://hackmd.io/mqYR5iVjTIWDiI8Bn6GANA)
## Ronny
* Project: [Gardening Docs Wikipage](https://wiki.opennms.org/wiki/Dev-Jam_2018/Gardening_Docs)
* Topic Chat: [DevJam2018-gardening-docs](https://chat.opennms.org/opennms/channels/dj2018-gardenin-docs)
* Drafts for structure refactoring: https://hackmd.io/rB38Uo6hQNiDwF07HRs2RQ?both
### Schedule:
* Kick-off Meeting Monday 13:00 ([UTC-5](https://www.timeanddate.de/zeitzonen/konferenz-detail?year=2018&month=6&day=11&hour=18&min=0&sec=0&p1=159&p2=37)), I'll send you a link in the topic chat for the meeting. I'll use "meet.google.com".
* Discussion: OpenNMS in Containers from a configuration perspective. Time TBD.
---
## mhuot
### Meetup Monday morning
#### Attendees
* Jesse
* Jeff
* Marcel
* Ronny
* Alejandro
* Tarus
* Chris
* Ron
#### Notes
* Consolidation with the main source code has been a big win
* AsciiDoc move has worked well as most documentation is created by technical people not writers
* Generation to HTML so it can be available on the install site has also been a good thing
* Different target groups
* Admin
* Dev
* Install
* User
* Some confusion around Admin vs User
* Perhaps we look at mashing them together then pulling user out
* User could become a series of how to's
* Discussion around tooling
* Current setup is long HTML pages, navigation is long as well
* The provisioning guide has 6-8 levels deep
* Most valuable
* Most complete, but does need some update/cleanup
* Move to reference guide to reduce length
* Dedupe the common steps
* specifics for particulars in guide
* We need to get rid of the mailing list
* We have many different ways to contact us for help
* Still have questions at Town Square on Mattermost
* Should have an asynchronous way
* Forum with email notifications?
* Stack Overflow?
* ask.opennms.eu was basically a locally hosted PHP stack overflow
* ask.opennms.eu is redirected over to stackoverflow.com tagged opennms
* ask.opennms.org now does the same(thanks Chris)
* Started to merge the user and admin guides
* Need to re-write path outage
* List of the missing stuff
* Finding all of the monitors was easy
* Need to pull out the duplicated parts where there is lots of the same steps move to a reference guide.
* Do we track doc access on web site
* We believe google analytics has ben deployed
* Styling is difficult
* Do we use styles?
* Is branding important? Probably not
* Tooling
* 3 tools
* Asciibinder
* Antora
* sphinx
* Most popular
* used by readthedocs
* Very python
* Uses RST
* We would have to covert everything
* Have to look into versionizing and deploying new structure
* Focus on content
* Structure what we have
* If we want to convert later we can
* Do we need a troubleshooting guide?
* User guide would have features
* Should it be same or different doc?
* Tarus to notifiy lists that going away on August 1st(or other date)
* Redirect everyone to StackOverflow
* Set the audit bit to yes
* Every list
* Archive of messages will remain
* If we have a bad response on SO
* Is there an abuse policy?
* If we have a bad one we need to post a better answer for the community to vote up
* Vote down the trolls!
* Need to start taking metrics on MatterMost to better understand how it is used
* Number of people on our channels to understand
* Chris can help out on this
* IRC was never more than 100 people with MatterMost we have 660+ people in Town Square
* Where does wiki go?
* Use cases
* Template tag
* Official docs
* Wiki has become a directory to other places
* Should we move to some other place?
* Easy for users to add
* Should we go to Confluence?
* Internally used at TOG
* Table until next year
* Are people updating?
* It is an entry point to contributors
* Install guide
* Has a lot of theory
* Minion's best information
* Should be Minion have its own guide?
* WS-MAN OpenNMS config is easy
* How to do the restricted domain account etc is hard part
* Should we direct elsewhere?
* Provide hints where else to learn more
* Should we link to Tarus Videos?
* Can we make major sections based on commonly used?
* Performance Management
* Fault Management
* Walk through structure
* for things like
* How to create a requisition?
* How to add a new monitor?
* How to add a new data collection?
* Order of the things will be by most popular
* Static structure that has a page that highlights the most common
* ORder of things based on how the system is built up, like you need to add nodes first
* Could we have a checklist?
* Tomorrow everyone looking at the structure that might work and present tomorrow to see if we can put them together
---
## Wednesday Morning Meeting
* Tutorials
* should be split out
* Some of our "tutorials" are not tutorials, especially data collection. It is more
* Who and Why, concept
* What, refrence
* How - user stories in action
* Do they belong in the official docs?
*
* Need a getting started
* Use training materials as guide but not take completely
* Give new user sense of accomplishment
* For those with short attention spans
* Install guide is about the different ways to install
* Admin guide
* Top level is completely mixed up
* Alejandro's suggested top levels, structure by function
* Inventor
* FM
* PM
* UI
*
* Troubleshooting