Convert Linux Commands into a Different Format - Githubissues

LukeShortCloud / rootpages

Root Pages is a collection of easy-to-reference tutorials and guides primarily for Linux and other UNIX-like systems.

Other

57 stars 6 forks source link

Convert Linux Commands into a Different Format #1

Open LukeShortCloud opened 7 years ago

LukeShortCloud commented 7 years ago

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
[x] Clustering
[x] Compression
[x] Configuration Management
[x] Firewalls
[x] Hardware
[x] Linux File System Hierarchy (LFH)
[x] OpenStack
[ ] Networking
[ ] NoSQL
[x] Package Managers
[x] Permissions
[x] Phones
[x] Regular Expression (RegEx)
[x] Security
[ ] Shell
[x] Source Code Management
[ ] SQL
[x] Storage
[x] Text Editors
[ ] Tips & Tricks
[x] Virtualization

LukeShortCloud commented 6 years ago

These documents are now being exported as HTML pages instead of an Excel sheet. This helps to make it more Git and user friendly when viewing the "git diff" history. This is a step in the right direction. These should still be rewritten into a text format.

LukeShortCloud commented 6 years ago

The last update for Linux Commands in the old format will be the next one. I will start migrating these into a more Git-friendly text document for 2018.

LukeShortCloud commented 6 years ago

CSV is supported by Sphinx, which is great now that we support it.

http://www.sphinx-doc.org/en/stable/rest.html http://docutils.sourceforge.net/docs/ref/rst/directives.html#id4

LukeShortCloud commented 6 years ago

Perhaps the "Linux Commands" references should be migrated into existing Root Pages for each topic? For example, there is a "Virtualization" section in both Linux Commands and the RST document. These could be merged.

LukeShortCloud commented 6 years ago

Final decisions were made and the migration process has started in the "linux_commands_conversion" branch.

Linux Commands will remain separate from the guides.
Linux Commands will use CSV tables.
At first, for simplicity, the bibliography (previously labeled as "URLs") will be copied verbatim from the original Linux Commands. Better (and more direct sources) will be added at a later date

LukeShortCloud commented 5 years ago

Added the file system hierarchy information to the File System guide via: https://github.com/ekultails/rootpages/commit/1ff4f6f2651646ee9081da5e6fccac8c679eb97a

LukeShortCloud commented 5 years ago

Added regular expression to the DevOps guide via: https://github.com/ekultails/rootpages/commit/cf1af64c26703bb96db4492ffa8f0d8464bcf723