For contribution guidelines, see Contributing to Rockstor documentation
rockstor / rockstor-doc Goto Github PK
View Code? Open in Web Editor NEWRockstor documentation
Home Page: http://rockstor.com/docs
License: Other
Rockstor documentation
Home Page: http://rockstor.com/docs
License: Other
For contribution guidelines, see Contributing to Rockstor documentation
From
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.
Create documentation for api, to help a user using the api client to automate storage operations.
@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
The Search box top right on current web rendered docs is broken in that it always returns no entries.
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.
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.
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.
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)
minor tweaks to the recently upgraded Contribute to Rockstor doc
On the Quick Start page we could advise against using unetbootin as a Rockstor forum member found that the resulting usb install key was unable to boot successfully.
Thanks to @herbert for finding and reporting this issue on the forum.
Linking to the forum thread so that it might be updated on resolution of this issue:- http://forum.rockstor.com/t/solved-installation-fails-on-hp-microserver-n40l/418/3
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.
Add the missing btsync rock-on guide and update forum links to recently created specialized sections
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.
Update documentation with
List of raid levels that can be used while creating a pool
description of each
min no of drives
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.
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.
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.
Major user improvements in 3.8-4 to task scheduling so would be nice to have docs reflect this.
Add to feature list.
Add walk through and test procedure
I am now working on a pull request for this.
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.
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.
Search bar missing in the updated Documentation.
It would be also good tell users what information to send when contacting for support.
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".
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 a how to document describing the process of migrating large amount of data to Rockstor.
A KVM howto as an alternative / compliment to the VirtualBox instructions might be nice.
Working on pull request to supply this.
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.
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.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.