Giter VIP home page Giter VIP logo

wtfdocs's Introduction

WTF Docs

This site is built using Material for MkDocs.

Development environment setup

  1. Install python 3
  2. Create a virtual-env:
python -m venv virtual-env
source virtual-env/bin/activate
  1. pip install -r requirements.txt
  2. mkdocs serve

To add documentation for a new module

  1. Create a new Markdown file in the /docs/modules directory
  2. Add a new route in the mkdocs.yml file, under the nav: section.
  3. To add pictures, add the image to ./docs/overrides/assets/modules/<IMAGE>.png

Deploying

  • Merge changes into master
  • Run mkdocs gh-deploy --force to push the changes to the gh-pages branch on github.com
  • Commit the resulting changes into master

wtfdocs's People

Contributors

ameobea avatar andrewscibek avatar bizzaro avatar c123r avatar choromanski avatar chrisdbrown avatar devenda-avoma avatar dhutty-numo avatar doctorfree avatar elliotrushton avatar ginner avatar gnanderson avatar imdevinc avatar indradhanush avatar inetant avatar jeffz avatar jmks avatar joel-valentine avatar jonhadfield avatar lawrencecraft avatar linenoise avatar mweb avatar pliski avatar retgits avatar rudolphjacksonm avatar rwhogg avatar seanstoppable avatar senorprogrammer avatar stone avatar trimble avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

wtfdocs's Issues

Security Widget gives wrong firewall info for non-root linux users

The security widget is supposed to show the firewall status. This works great in Windows where 99% of users are running windows in single-user mode (as Administrator). However, in linux, in most distributions of the defualt installations, have to be root or use sudo with password in order to get the correct firewall info. I.e. to run sudo ufw status. This fails on several levels in the security widget.

There are 3 work-arounds:

  1. by creating a new firewall group and add your user to it.
  2. by enabling full access to the firewall indiscriminately to all users, which create a huge security hole.
  3. run WTF as root, which is definitely not recommended, and create it's own issues with GO installation.

1 is the way to go and need to be documented

Build & Test Docs Site with CI & HTML Proofer

Hey,

I'm a big advocate for static docs sites and Hugo in particular (I'm a contributor). I see that this docs site is built with Hugo but not on CI.

I propose that this site gets built on CircleCI, this way PRs can be checked automatically before merging. There's a tool that I've used with Hugo and Jekyll-based websites called HTML Proofer that can test the generated static site for errors. My favorite usecase for it is to check for broken links though it can also check your HTML structure as well to make sure that well formed HTML pages are being generated.

A few examples of how this works:

Feliciano.Tech/config - my personal site, built with Hugo and tested with HTML Proofer
CircleCI Docs/config - CircleCI's documentation website, built with Jekyll and tested with HTML Proofer
Patheon Docs/config - Docs site for Pantheon Hosting, though they're using Gatsby instead of Hugo

I can get a PR going if this sounds good. Just wanted to ask/discuss first.

[docs] make openFileUtil configuration item documentation clearer

What should it do?

Explicitly stated that the openFileUtil configuration item needs to be restarted to take effect.

What have I met?

I tried to modify the openFileUtil configuration item, but it didn't work. After reading the source code, I realized that this configuration item needs to be restarted to take effect. But I cannot get the instructions from the documentation (including wtfutil.com).

So I hope that you can further explain this configuration item in the documentation, thanks.

Docs on how to uninstall?

Is there any information on how to uninstall wtf? I'm wary of installing anything that doesn't have a clear back out plan.

Images on site are non-zoomable

"There's a detailed screenshot but I can't zoom to see the detail because the website designer has gone the extra mile to make it non-zoomable. Why do people do this?"

meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"

Add instructions how to run WTF with/without root

  • Running WTF on linux without being root has a few consequences (but is the recommended way).
    I.e. #15
  • Running as root, has other drawbacks, not making wtf run out-of-the box, unless it was cloned and installed by root

Add simple social meta tags

This would allow to give a short description/title as social card embed, e.g. on social networks such as discord.

Reorder the doc format

Having the src entry at the top above more useful information doesn't make much sense. Most users won't care about where the module lives in the code, they care about how to configure the module to get it to work.

Put developer stuff last.

Improve quick start UX

Adding the verbose flag to the Quick Start commands may help telling the user that something is actuay happening, instead of a dead terminal for (several minutes) on an old machine.

Please rewrite to:

go get -v -u github.com/wtfutil/wtf

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.