Major documentation rework -- Entities and Ubiqtorate still need cleanup.

This commit is contained in:
2020-10-09 04:19:07 -05:00
parent f506025c54
commit a118037532
76 changed files with 1011 additions and 1246 deletions

View File

@@ -1,36 +1,19 @@
To get started with the AniNIX stack, some familiarity with key concepts and technologies is encouraged.
The AniNIX is currently recruiting user involvement. As such, we're providing some example background here for new persons, broken down by background. Thank you to everyone who is contributing now!
# The AniNIX
Contributing users should be familiar with the following pages, though these are only a selection of [[:Category:Operation|our operational policies]].
* [[User Ethics]] for the integrity required of contributors and users
* [[Design Principles]] -- how to design projects
* [[Development Best Practices]] for safe project work
* [[QANs]] for requesting bug fixes, and [[Bug Bounties]] for ongoing research projects.
# Everyone
Everyone should be willing to report issues with AniNIX software, documentation, or provided services -- connect to [IRC](https://irc.aninix.net/) or any of our social media to report these issues. Also sign into this service if you have an idea for new functionality, enhancements or other improvements the AniNIX should be considering!
# Basic Applications
RSS (Really Simple Syndication) is a format of [https://en.wikipedia.org/wiki/XML XML] files presented over Internet HTTP links. It requires a reader like [[AniNIX::Singularity]], but many sites will have an orange icon with a dot and three curves to indicate their RSS feed -- we have one on our [https://aninix.net/ Root] page.
# Administrative, Legal, or Business Staff
Administrative, legal, or business staff are especially encouraged to review the mission statement, design principles, and development best practices in [Policies](/AniNIX/Wiki/src/branch/main/Policies) and [Policies](/AniNIX/Wiki/src/branch/main/Policies). This is the "business" and "legal" model on which the AniNIX runs and is currently vague in non-technical aspects.
IRC or Internet Relay Chat is our primary means of communication. IRC clients connect to an IRC server -- the server also hosts services, such as a channel registry (ChanServ) and nickname reservation (NickServ). Our [[IRC|IRC Wiki page]] has details on clients to connect to our IRC, as well as links to tutorials and a channel mode listing.
# Artists
Graphic designers are encouraged to review our stylesheets and any repo icons to help provide artistic direction. The current aim is a near-terminal like look with white-and-black icons surrounded by red hexagon. Review our (Design Principles](./Design_Principles.md) to understand our motivations and aims. We welcome criticism and debate on these points.
[[Wiki]] is a Web application for community-driven content. Wikipedia maintains a [https://en.wikipedia.org/wiki/Help:Getting_started Getting Started] guide that's excellent reading for new users of the application.
# Educators
Educators will be exceptionally helpful in reviewing documentation. Anything on this Wiki and any other repo's Markdown files could be reviewed for clarity and understanding. If concepts aren't adequately explained we need to know so that we can link to wider documentation or clarify.
Git through [[Foundation|AniNIX::Foundation]] is a complicated system. While known as the "stupid content tracker", there are books written on Git for its many features. New users should start with the [https://linux.die.net/man/1/git git] man page and [https://linux.die.net/man/7/gittutorial turorial].
# Physical Activity Professionals
[AniNIX Martial Arts](/martialarts) is always looking for input on how we teach, exercises we use, and other technique suggestions. Feel free to stop by any time.
The shell is the user's primary method of interacting with the OS -- this is done with a local or remote terminal emulator. TLDP has a very [http://tldp.org/LDP/Bash-Beginners-Guide/html/ valuable guide] that new persons should read.
# Code Development
One of my favorite places for learning code development is [https://www.codingame.com/start Codingame], where students are given challenges to solve in their programming language of choice. Compiled code on the AniNIX generally is written in C# or C, and we'd recommend new users choose one of these if they want to contribute to new projects.
Users should also see [https://www.w3schools.com/ W3Schools] for front-end development through the HTML/CSS/PHP/JavaScript stack for a [[WebServer]]. HTML is used to create the structure of the page, CSS the format of colors etc., PHP for server-side code, and Javascript for client-side code.
# The Operating System
To get started on the operating system, Google:
* [http://google.com/search?q=Unix+Basics Unix Basics]
* [http://google.com/search?q=OSI+Model OSI Model] and IPv4 Routing
* [https://wiki.archlinux.org/index.php/General_recommendations ArchLinux General Recommendations]
# Learning about Security
* Users should try to go through [https://ssd.eff.org/ Surveillance Self-defense] from the Electronic Frontier Foundation.
* Younger users can use [[:Category:Google|Google]]'s [https://beinternetawesome.withgoogle.com/en_us Be Internet Awesome].
[[Category:Operation]]
# Technical Personnel
These folks are the core of the AniNIX contributing community. This wiki and [https://aninix.net/foundation the Foundation git repo] need review and comments. Submit [issues](/issues) as you see the need.