Giter VIP home page Giter VIP logo

rockstor-doc's Introduction

rockstor-doc's People

Contributors

dbivolaru avatar dbzs avatar fantastitech avatar florianduclot avatar froggyflox avatar george-andrei avatar gompa avatar hbdk avatar hooverdan96 avatar lifton avatar magicalyak avatar mazo avatar mflyer avatar mikemcpherson avatar nfriedly avatar phillxnet avatar priyaganti avatar rlndvt avatar schakrava avatar snamstorm avatar stitch10925 avatar sujeetsr avatar testingdoc 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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rockstor-doc's Issues

add responsible disclosure doc

We need a clearly reference means for those wishing to responsibly disclose security issues concerning Rockstor related components over and above those of upstream, although if any upstream related issues were submitted they could be up-streamed to openSUSE/SuSE.

Documentation for API

Create documentation for api, to help a user using the api client to automate storage operations.

community link broken

@schakrava On the top bar of the docs as rendered on the web the community link is broken, it seems to link to a "#". With the locally generated output from sphinx it generates a drop down menu with the expected and working links to forums and the issue tracker.

Could this be related to the bootstrap.css to bootstrap.min.css patch:-
85c15f5

Search Box Broken

The Search box top right on current web rendered docs is broken in that it always returns no entries.

contribute doc affects users global git config unnecessarily

Contribute doc suggests using --global which will re-write users existing global git config when the scope of the instructions concerns only the particular repo.
Also the addition of a cd command should help for a smoother on ram.
I am preparing a pull request on this issue.

plex-howto rock-on guide

Given Plex is a very popular server software at least in the home NAS field a quick guide on installing via a Rock-on might be nice. Especially given the Rock-on system is now coming along.

I am working on a pull request to this end.

add rock-ons intro

Prior to writing each separate Rock-on howto we first need to introduce Rock-on to the docs and explain what they are and how they are implemented. Write what is common to them all so that each can then index back to this initial set-up / explanation.

Rockstor updated itself to an "unsupported" kernel

I have not run anything in the CLI of my test VM, only ran the WebUI update command. I received this error in the WebUI after my second reboot.

You are running an unsupported kernel(3.10.0-123.20.1.el7.x86_64). Some features may not work properly. Please reboot and the system will automatically boot using the supported kernel(3.18.1-1.el7.elrepo.x86_64)

Update samba documentation

Creating Samba share documentation should be updated to reflect the fact that Samba exports are now created from the sidenav Samba menu item, instead of on the share details page.

multi period snapshots

Document self thinning daily, weekly, monthly, yearly snapshots.
ie creating tasks as follows:-
daily (max count 7) snapshots
weekly (max count 5) snapshots
monthly (max count 12) snapshots
yearly (max count 2) snapshots.

Gunicorn HTTP server hogging CPU

Version 3.6-9. I am running a VM in ESXi with 1 vCore of CPU and 2gb of ram. This is obviously for testing purposes. Gunicorn seems to be hogging the most CPU out of all processes. It never dips below 20% usage and is continually over 40% usage. I got these numbers with TOP on the CLI. This is the only command I have run on the CLI so far.

Here is my dashboard in case the graphs and statistics are somehow causing HTTP server CPU hogging.
image

Broken YouTube link in install.rst

The last link under "Quick evaluation" heading in the install.rst doc is broken.
The link is intended to show how to evaluate Rockstor using Virtualbox.
There exists a video on rockstorinc that covers this so I am preparing a pull request to correct the link.

document config backups

As a new neat and key feature I'd like to see this referenced in the documentation; I will try and prepare a pull request for this tomorrow (UK).
I am planning to add this at least as a section in the existing "Reinstalling Rockstor" howto.

email config and test

Add to feature list.
Add walk through and test procedure
I am now working on a pull request for this.

Improve DandP section

In response to a forum suggestion by @marks I think we should update the Disks and Pools section, specifically add that we can now import from whole disk btrfs disks. This has already been documented in the recent "Reinstalling Rockstor" Howto so an additional section within D and P referencing this may help with discovery of this feature. Also rather outdated pics in this key section.
Note we can also mention this facility in Basic Concepts - Disk section.

Link to forum post to update on issue resolution:- http://forum.rockstor.com/t/possible-to-use-partitions-not-whole-devices-for-btfs/396/8

I am later today to work on a merge request to address what I can for now on this issue.

add reinstall howto

A small howto detailing the re-installation process, ie extra steps needed during installer.
Also a note about importing data from previous Rockstor data disks.
Once in could also be a place to detail the future feature of config save and restore.

Add documentation describing DR situations

A useful comment from HN

My very first questions regarding a potential storage solution revolve around data loss:

1. Can we enumerate the data loss scenarios?
2. How is drive failure handled?
3. How may data be corrupted and such corruption detected?
4. For every data loss scenario, what is the recovery procedure?

Here is all I could find: http://rockstor.com/docs/faq.html#how-do-i-prevent-data-loss...

Of course, there is a wealth of information on such questions for standard RAID, but I would suggest for marketing purposes that rockstor synthesize available information (from the many relevant layers of data management) in a coherent fashion, specific to their product. It doesn't have to be deep, but it should be at least minimally comprehensive and broad, with pointers to more detailed, layer-specific information.

Also, it's fine if the recovery scenario is "restore from backup" for e.g. the scenario where data is deleted by an authorized user. If so, there should be at least a minimal "backup story".

add media check directions

In the install section we should include or point to a howto on confirming the created media's integrity.
ie via "Test this media and install Rockstor" boot option.

add kvm howto

A KVM howto as an alternative / compliment to the VirtualBox instructions might be nice.
Working on pull request to supply this.

small pwreset section

I think it would be nice to have a dedicated section to take people through the pwreset procedure, ie that one uses the root login credentials setup during install and a terminal via ssh root@ or via putty on windows. This could have pics etc so it's all friendly and re-assuring and have a hight link status so users see it early on in docs. Also link to this section from the install section so the root user relevance is made early on for this task.

sphinx and subdirectories

for some documents like rocksons and reinstall, we are using subdirectories which is breaking the links to the logo. We need to figure out the right sphinx config changes so it populates the static files correctly.

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.