@Pete-S said in Formatting text instructions into html?:

@stacksofplates said in Formatting text instructions into html?:

I prefer asciidoc to markdown. Asciidoc has actual standards for things. Antora will build a pretty nice site with your projects written in Asciidoc as well.

Ifyou just want a single page, Asciidoctor will build a site as well.

I had a look at asciidoc and it looks very nice, especially for larger documentation projects.

I have a couple projects in an Antora site. We had a ton more at work, but I can't show it on here. You can include multiple projects and have them appear at the bottom left, each with versions. We used it so that teams could create documentation for tools (or really whatever they wanted) and then that documentation could be scraped and included in the central site. I just have a few projects included in my site, but Antora makes that pretty easy.

Here's my very bad/basic example.

https://docs.hooks.technology

@IRJ said in Documenting Firewall Exceptions and Rules:

@DustinB3403 said in Documenting Firewall Exceptions and Rules:

I had to add some rules to a CentOS 8 server because some things stopped working that were previously working. (Not sure why this worked before, but it did)

Adding a few rich rules resolved the issue immediately.

None of this makes any sense. It's deny all and permit by exception. Why would you do anything else?

That's the default, and that's what was working just fine for a long time. Suddenly it began "not working" and needed the exceptions made.

I've exported his PDF's and converted them to ODT files for editing, they are currently available from Github here I've sent @Ylian an email requesting he pull these files over so the community can assist with updating this documentation.

Network Documentation is very very important, for Network Admins is a must, because for example a new team member joins, this information will be useful to acknowledge the network infrastructure.

@magicmarker said in The Extensive Guide to Using VMware Documentation Like a Pro:

@NetworkNerd Excellent. I saw someone post this blog in the reddit VMware forum as well. Thank you!

Sure thing - I'm happy you found it helpful!

BookStack is now supported on LXQ for easy deployment

Here's a list you can format and add/subtract to/from:

QUESTIONS FOR FORMER IT PROVIDER
Domain admin username and password:
Domain registration details and logins:
Domain DNS hosting details:
Domain Web hosting details:
SSL Certificate provider login details:
Local PC usernames & passwords:
(If applicable)
List of Microsoft Servers and roles:
Switch details and logins:
Router details and logins:
NAS details and logins:
Access Point details and logins:
Printer/MFP details and logins:
Web filter proxy (If applicable):
Key IP addresses & usernames / passwords of anything else relevant i.e Office 365, Cloud Services:
Server details (brand, model, serial, warranty):
Virtual Environment details:
UPS details (Logins / warranty):
Antivirus uninstall passwords (all products):
Cable or Fibre details (provider plus account details – login):
Secondary Internet Connection (If applicable):
Offsite backup details eg. Storage, S-Protect licences, cloud services:
Wireless Network SSID / Password:
Service Account Usernames and Passwords eg. Backup printers:
iLO / iDRAC login / password:
Remote access methods:
Phone System:

Licensing
MS Licence Agreements / Login:
Antivirus / malware / Spam – product, login and expiry:
Firewall – Model / Serial / Licence expiry and supplier:
Virtualisation agreements (VMWare / Hyper-V):

Software Management
Provide details on all business applications:
SharePoint (If applicable):

Documents to be provided
Router / firewall details:
Switch / Router Configuration Files:
Any VPN Config – pre shared secrets / config:
System Documentation including diagrams:

Outstanding Problems or Project work to discuss
Current issues, tips on support / maintenance, etc:
Active / unfinished projects:
Support contract expiry date:
Pre-paid support hours in credit:

@thwr said in Graphical network documentation tools:

@dashrender said in Graphical network documentation tools:

@thwr said in Graphical network documentation tools:

@jaredbusch said in Graphical network documentation tools:

I just want to tour I can click a button or switch type a number of ports and they just put something on the goddamn street I hate Visio and dealing with specifics stencils and all the right things just give me some generic fucking pictures

^ this

Give me a few days, I'll have a meeting with the DC guys soon.

But yes, I'm in the same boat: I would like to click on a VLAN label and see a list of all associated access ports. Or I want to click on a cable and see the patch field number. Can't be this hard. There are some tools out there, like http://demo.racktables.org/ etc. But it looks a little bit like ... eye cancer 😉

Sure, but I don't really consider that the same as Visio. That's like saying that notepad is the same as Word, one is a in general basic visual diagram solution, the other is an imbedded data mine with GUI to the data.

I've never asked for Visio or similar tools but everyone's way to document their cables and devices 🙂

lol I guess you did... but I don't know of many (any off hand) that have an interactive documentation solution like this.

I know Spiceworks has a thing that kinda does this - but it sucks pretty bad and offers little if any ability to edit it to be more accurate.

@jaredbusch said in How one prevents screwing oneself half a year later:

I setup a Fedora 25 VM for a friend a while back on my server in our colo in order for him to republish a bunch of D&D stuff he used to host from home years back.

I wanted to verify the root password today, but could find no notes on my personal Nextcloud and I could not guess it as you can see.

But I apparently left myself a note in my user's home folder.

[jbusch@naggaroth ~]$ ls -l total 4 -rw-rw-r--. 1 jbusch jbusch 39 May 29 2017 note

0_1512965448432_d05b19c7-ac12-4a53-9219-3260a857ae21-image.png

Lol! Don't you just love when you plan ahead.

Nowhere near bedtime here. Just finished dinner.

@JaredBusch said in Ideas for ITSP and MSP Internal and Customer Documentation:

@jmoore said in Ideas for ITSP and MSP Internal and Customer Documentation:

Didn't have time to mess with anything last night because of family. Hopefully tonight. I'm excited to try Wiki.js and Bookstack

If I was turning up something for only IT, and had the authority to force people to use it, I would only use Wiki.js. I totally love the git based backup thing.

Yeah, thankfully we have that flexibility.

@scottalanmiller said in Organizing Documentation with MediaWiki:

@Dashrender said in Organizing Documentation with MediaWiki:

@scottalanmiller said in Organizing Documentation with MediaWiki:

@Dashrender said in Organizing Documentation with MediaWiki:

@scottalanmiller said in Organizing Documentation with MediaWiki:

Yeah, but we can't access that. It's $20 for us. That's just the price, can't get around it.

If you're really planning on dropping all the way to the $4/u/m exchange only plan, then you can probably move to the $5/month plan (you have less than 250 users, right? and get what I have today.

MSP, doesn't work that way. We need our E3 plans. Seriously, we don't have any option for the $5 stuff.

then you're paying $20 already - so what difference does it make?

That we can't get the $5 plan. So we can't have OneNote and SharePoint without paying the $16 premium per user. We are going in circles. I'm back to explaining the original price post.

Also, FFS, quit cluttering up the wrong damned thread.

@scottalanmiller said in IT Documentation Helpers:

Problem with SYDI is that it is limited to Windows servers, no Linux or other support. Not bad, but an important limitation. Mostly it is Windows that is needing to be documented so it covers a lot of ground, though.

SYDI has a Linux tool. I haven't used it, so I don't know it's limitations though.

Always good to check with upper management.

"Hey boss' boss, just wanted to run this by you. My boss needs me to document trivial IT tasks that the intern (that we don't have) should be able to look up without a problem and spend time and company money maintaining them so that he, not I, can repeatedly do entry level tasks without needing to get assistance from elsewhere. I'm happy to do this but this puts us at risk of the documentation being wrong since I am just making copies of the industry or vendor documentation, and because it is impossible to keep every internal doc continuously in sync with the latest vendor changes, guidelines and best practices. Just wanted to make sure that you agree that making this kind of documentation, all for one person, is a good use of government financial resources?"

If given time (and money) to make documentation, I tend to like it.