Documentation files that need some updates

bmfmancini commented 3 years ago

@jpobeda, @netniV, @Linegod, @cigamit @BSOD2600, @bmfmancini, @TheWitness

I went through some of the documentation tonight I found the following files that can use some more details in them I will work on the Automation files as well as moving the Spine documentation under data collection

In Process:

[ ] @bmfmancini - Data Sources needs some work
[x] @TheWitness - Redo plugin doco to more closely match current practice of using github to host plugins. Improve code examples.

Future:

[ ] Add better documentation for User session https://github.com/Cacti/cacti/pull/4071
[x] Mention our new YouTube Channel
[ ] Add plugin doco for high value plugins (thold, syslog, monitor, maint, ...)
[x] Graphing a Custom Script needs images
[ ] Settings up an HA Cacti with MariaDB Galera, HA Proxy, GlusterFS, keepalived, database Apache sessions, read vs. write query ports, etc.

Done:

[x] Discovered Device
[x] Automation Device Rules
[x] Automation Graph Rules
[x] CDEFS - Add more info on CDEFS to DOC
[x] VDEFS - Add more info on VDEFS to DOC
[x] External Links - Just needs some wording to descriptive whats going on
[x] Add Spine documentation to Data Collection section in readme.md
[x] Managing your user profile
[x] Discuss Moving the tutorials to separate section
[x] How-to-Graph-Your-Network.md
[x] Data Debug Needs Wording
[x] Data Templates is a Blank Page
[x] Export Templates is a Blank Page
[x] GPRINTs is a Blank Page
[x] Principals of Operation is insufficient and images are bad
[x] SNMP Data Query Example has old images
[x] Need an image or two in LDAP settings
[x] Templates includes a walk-through, should that be in our walk-through section?
[x] User Domains needs some Context. Why use them, sample login page with multiple defined, howto setup
[x] User Management needs some words and explanations as to how things are working
[x] Variables has old images
[x] Spine doc needs some more detail
[x] @bmfmancini - Automation Tree Rules
[x] @bmfmancini - System Utilities - Update Doc with the recent additions of tools, add some meat on the bones for sure
[x] @TheWitness - How-to-Graph-a-Custom-Collection-Script.md
[x] @TheWitness - Cacti Settings Pages in an organized fashion
[x] @TheWitness - Command Line Scripts Needs Updating
[x] @TheWitness - Script Walkthrough has old images
[x] @TheWitness - Move Walthrough out of Data Input Methods to the How-To section

@TheWitness I am checking out your new commits as a second set of eyes this is related to https://github.com/Cacti/documentation/issues/7

TheWitness commented 3 years ago

Thanks for taking on the automation @bmfmancini. I'll take the CDEFs and VDEFs.

netniV commented 3 years ago

If you update the list to use the following style, you'll be able to mark things offf:

- [ ] [File Name 1](GitHub url 1)
- [ ] [File Name 2](GitHub url 2)
- [ ] [File Name 3](GitHub url 3)

TheWitness commented 3 years ago

All the plugin stuff needs a dusting off too.

bmfmancini commented 3 years ago

Yeah that too

Actually thold and monitor don't even have one at all I will take care of the monitor one and try to squeeze in thold during the week

On Sun., Jan. 3, 2021, 21:46 TheWitness, notifications@github.com wrote:

All the plugin stuff needs a dusting off too.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Cacti/documentation/issues/89#issuecomment-753729006, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADGEXTCZWQ4PKV6VSJ5KLUTSYETXHANCNFSM4VSJMOQA .

TheWitness commented 3 years ago

I would have no problem adding: thold, syslog, monitor, and maint plugins into the core documentation.

bmfmancini commented 3 years ago

I have submitted a PR for Automation Discovered devices Moved the Spine doc to the data collection section Updated the external links doc just making travis happy now

TheWitness commented 3 years ago

I realized we did not have anything on User Profiles. Can you check to see if there are pages for the Settings tabs.

bmfmancini commented 3 years ago

@TheWitness User profiles are covered in users

bmfmancini commented 3 years ago

I think we should move the tutorials to its own section like a HOW TO section

Also for the plugin Docs I think we can do something like

Cacti Supported/Maintained plugins

Threshold

1 2 3 4

Monitor

1 2 3 4

TheWitness commented 3 years ago

Yea, as separate chapters though. I can spend a lot of time on Thold alone. Monitor and Thold should be stuck together, even merged. One step at a time though.

bmfmancini commented 3 years ago

Ok cool

On Mon., Jan. 4, 2021, 20:34 TheWitness, notifications@github.com wrote:

Yea, as separate chapters though. I can spend a lot of time on Thold alone. Monitor and Thold should be stuck together, even merged. One step at a time though.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Cacti/documentation/issues/89#issuecomment-754328457, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADGEXTGOI5TDMQZR7MXG2QLSYJUCNANCNFSM4VSJMOQA .

TheWitness commented 3 years ago

I banged through the existing doco and added stuff to the list.

TheWitness commented 3 years ago

Did a few more. Long way to go.

TheWitness commented 3 years ago

Ran out of steam today.

TheWitness commented 3 years ago

Getting most of the way through the files and found the following list of unused files:

images/add-site.png - 0
images/automation-networks-edit2.png - 0
images/cacti-page-layout.png - 0
images/data-input-methods.png - 0
images/data-input-methods-edit1.png - 0
images/data-input-methods-edit2.png - 0
images/data-input-methods-edit3.png - 0
images/data-source-title-template.png - 0
images/data-templates-view.png - 0
images/data-templates-view-edit1.png - 0
images/data-templates-view-edit2.png - 0
images/dc-01.preview.png - 0
images/device-console-window.png - 0
images/graph-management.png - 0
images/graph-management-graph.png - 0
images/graph-tree.png - 0
images/plugins.png - 0
images/r-dq3.png - 0
images/settings-visual-1.png - 0
images/settings-visual-2.png - 0
images/settings-visual-3.png - 0
images/system-utilities-boost1.png - 0
images/system-utilities-boost2.png - 0
images/system-utilities-main1.png - 0
images/system-utilities-main2.png - 0
images/system-utilities-main3.png - 0
images/system-utilities-main4.png - 0
images/system-utilities-rrdcleaner.png - 0
images/system-utilities-viewagentcache.png - 0
images/system-utilities-viewagentlog.png - 0
images/system-utilities-viewagentmanagers.png - 0
images/system-utilities-viewclog.png - 0
images/system-utilities-viewdqcache.png - 0
images/system-utilities-viewpcache.png - 0
images/system-utilities-viewulog.png - 0

@bmfmancini were lot's of system utilities files. Were you still in the middle of this?

TheWitness commented 3 years ago

Oh, settings-visual. Just when you thought settings was done.

TheWitness commented 3 years ago

The command below get's you the unused files list.

for file in `ls -1 images/*.png`;do echo -n "$file - ";grep -r $file * | wc -l;done | grep " - 0"

TheWitness commented 3 years ago

Closer now

$ ./unused_images.sh
../images/add-site.png - 0
../images/automation-networks-edit2.png - 0
../images/cacti-page-layout.png - 0
../images/data-input-methods.png - 0
../images/data-source-title-template.png - 0
../images/data-templates-view.png - 0
../images/data-templates-view-edit1.png - 0
../images/data-templates-view-edit2.png - 0
../images/dc-01.preview.png - 0
../images/device-console-window.png - 0
../images/graph-management.png - 0
../images/graph-management-graph.png - 0
../images/graph-tree.png - 0
../images/plugins.png - 0
../images/r-dq3.png - 0
../images/system-utilities-viewagentcache.png - 0
../images/system-utilities-viewagentlog.png - 0
../images/system-utilities-viewagentmanagers.png - 0

Likely these images were created for a reason. We need to rationalize if the reason still exists.

bmfmancini commented 3 years ago

latest leftover images

images/automation-networks-edit2.png - 0 images/cacti-page-layout.png - 0 images/data-input-methods.png - 0 images/data-source-title-template.png - 0 images/data-templates-view-edit1.png - 0 images/data-templates-view-edit2.png - 0 images/data-templates-view.png - 0 images/dc-01.preview.png - 0 images/graph-management.png - 0 images/graph-tree.png - 0 images/r-dq3.png - 0 images/system-utilities-viewagentcache.png - 0 images/system-utilities-viewagentlog.png - 0 images/system-utilities-viewagentmanagers.png - 0

netniV commented 3 years ago

You may want to check if case sensitivity matters, or if there are typo's.

bmfmancini commented 3 years ago

PR request up for the Youtube Channel and moved around the graph single OID to the howto section

Cacti / documentation