Coder Social home page Coder Social logo

rootpages's People

Contributors

lukeshortcloud 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

rootpages's Issues

Add Sphinx Support

Sphinx is one of the top standards for building various types of documentation formats (ePub, HTML, PDF, etc.) based on RST or Markdown source code. This can even be used to create a full book. Root Pages should start using Sphinx for it's build process.

http://www.sphinx-doc.org/en/stable/contents.html

  • Convert documents from Markdown to ReStructuredText.
  • Run "sphinx-quickstart" to setup the build configuration files.
  • Remove old build scripts.
  • Update the README file on how to use Sphinx to build documentation.
  • Correct the headers to only have the title of each document (for example, "Ansible") be the #1 header. All other headers should be bumped down by one level to be nested under the document's title's name within a table of contents.

Update the Read Me with More Contributor Notes

  1. The Sphinx configuration file src/config.py needs to have the version updated to reflect the release date in ISO format (for example, 2018.01.01 for January 1, 2018). A new version will be created and tagged every 3 months.

  2. New contributors should look for these labels:

  • "new content"
  • "help wanted"
  1. Special notes:
  • OpenStack notes only have a major update when a new Red Hat OpenStack Platform long-life release comes out (every third release, starting with Newton). This update requires a lot of research to determine what has changed since the last long-life release.
  • Before a new release, one of the final commits should be a check for spelling corrections.

Convert Linux Commands into a Different Format

Despite the linux_commands guide being in a pretty format as Excel sheets, it would be more ideal to have it in a CSV (or similar) file format for viewing it via the CLI.

  • Administrative
  • Clustering
  • Compression
  • Configuration Management
  • Firewalls
  • Hardware
  • Linux File System Hierarchy (LFH)
  • OpenStack
  • Networking
  • NoSQL
  • Package Managers
  • Permissions
  • Phones
  • Regular Expression (RegEx)
  • Security
  • Shell
  • Source Code Management
  • SQL
  • Storage
  • Text Editors
  • Tips & Tricks
  • Virtualization

alliance!

hey noticed this great awesome project! I forked a project before that someone that started doing something similar. Is called linuxjourney. I moved it to gitlab cause I love gitlab.
https://gitlab.com/sysadminonlinux/linuxjourney
Maybe we should merge this stuff ? and avoid re-doing work ?

Fix the RST Table Format

Since these documents have been converted from Markdown to reStructuredText, the spacing within table boxes has been slightly off. Extra spaces were placed within the various sentences. This should be cleaned up and corrected.

[python] OOP

Explain how to use classes, objects, inheritance, etc. in Python.

Remove the Manually Created Table of Contents for Each Page

The builtin RST function .. contents:: will automatically generate a table of contents based on the defined headers. Each stub mentioned in the old table of contents should be removed and have a GitHub issue opened requesting it should be added.

  • ansible
  • authentication
  • bootloaders
  • c_and_c++
  • clustering
  • databases
  • dns_servers
  • file_systems
  • http_servers
  • linux
  • mail_servers
  • monitoring
  • networking
  • openstack
  • operating_systems
  • packages
  • python
  • security
  • virtualization
  • wine

Add a Bibliography to Every Page

Currently only the "Ansible" document has a bibliography due to it's large size. Other documents in Root Pages will have a short bibliography at the end of each section, instead of at the end of the entire document. For consistency, the references used should be stated at the end of each subject's document.

  • ansible
  • authentication
  • bootloaders
  • c_and_c++
  • clustering
  • dns_servers
  • file_systems
  • http_servers
  • linux
  • mail_servers
  • monitoring
  • networking
  • nosql
  • openstack
  • operating_systems
  • packages
  • python
  • security
  • sql
  • virtualization
  • wine

[virtualization] Incorrect Formatting

The conversion from Markdown to reStructuredText resulted in the "Virtualization" Root Page to not render correctly on GitHub. It works fine when using Sphinx on a local machine to convert it into HTML. This page will need to be have it's format checked over and possibly corrected.

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.