Commit Graph

57 Commits

Author SHA1 Message Date
Mrt134
92dca27659 Port changes made to trueos handbook:
- Update upgrade from pcbsd instructions.
 - Add new screenshot.
2016-12-13 09:36:37 -05:00
Mrt134
79a32b5009 Personacrypt and PEFS: TRANSLATIONS
- Update translation files.
2016-12-09 14:38:17 -05:00
Mrt134
607623d2bf PersonaCrypt and PEFS:
- Port changes to sysadmclient.rst from trueos-docs repo.
 * Document PEFS usage with PersonaCrypt.
2016-12-09 14:33:44 -05:00
Mrt134
6efbf5871e API reference guide addition:
- Added missing "run" action to dispatcher class.
2016-12-08 09:55:21 -05:00
Mrt134
3329c763d2 Update sysadm update manager: TRANSLATIONS
- Update translation files.
2016-12-02 11:18:17 -05:00
Mrt134
6a3ac878dd Update manager (updated):
- Updated documentation of the SysAdm update manager.
- Added a new screenshot.
2016-12-02 11:17:11 -05:00
Mrt134
5e921a7bb5 Server handbook update +license link addition: TRANSLATIONS
- Update translation files: client and server handbooks.
2016-11-22 11:01:03 -05:00
Mrt134
6e062f466e Server handbook update + License link addition for all handbooks:
- Added text describing the license of these handbooks along with a link.
- Fixed trademark replacements for the Server Handbook.
2016-11-22 10:56:36 -05:00
Mrt134
57065bf14f Sysadmclient.rst parity with TrueOS handbook: TRANSLATIONS
- Update translation files.
2016-11-04 14:08:06 -04:00
Mrt134
79d9a912f1 Sysadmclient.rst parity with TrueOS handbook:
- Update with trueos handbook pull request #9 tank1 zpool on screenshots.
2016-11-04 14:05:43 -04:00
Mrt134
751c98f2f0 Update to sysadmclient.rst: TRANSLATIONS
- Update translation files.
2016-11-01 13:37:29 -04:00
Mrt134
3914300bd6 Minor update to sysadmclient.rst:
- Fix a few trademark replacement errors.
2016-11-01 13:36:25 -04:00
Mrt134
ac981fced6 Update trademark replacement script: TRANSLATIONS
- Update translation files.
2016-10-24 11:50:10 -04:00
Mrt134
31673de619 Update trademark reUpdate trademark replacement script:
- Registered trademark replacement script now displays the symbol as a superscript.
- Fixed a build error with referencing an image present in the TrueOS handbook, but not with SysAdm. Rewrote the reference to stand alone and should now work in both handbooks.
2016-10-24 11:46:56 -04:00
Mrt134
c00cf735ad Update Sysadm Reference Guide:
- Fix errors with the responses for the dispatcher event system.
- Added notes explaining the various system states and their effect on the report.
- Renamed connections.rst to getstarted.rst to reflect the current handbook organization.
2016-10-17 15:43:16 -04:00
mrt134
309ffdb1df Update trueosstyle.css (all handbooks)
These elements are updated:
-Same size typewriter font for all these (same point size as normal font):
    :command:
    :file:
    :samp:
-(command is good, code.file still does 95% in main text)
-Table column headers like Description should be left-justified like table title and contents (also helps with finding them in wide browser windows)
-Semicircle ends on search box make it kind of not look like a search box.  Maybe just reduce the rounding.
-Font sizes in tables is reduced by one standard size.  No need for these to be smaller at all, just use the same size as main text.
2016-10-12 13:39:42 -04:00
Mrt134
5308c3e211 Update Client Handbook: TRANSLATIONS
- Update translation files
2016-10-11 15:21:48 -04:00
Mrt134
691d901856 Update Client Handbook:
- Port over sysadm.rst from trueos-docs; maintain parity
- Add new images to fix build errors
- Remove obsolete directory "TrueOS Handbook port"
2016-10-11 15:19:30 -04:00
Mrt134
e2ae246e15 Update client handbook with trueos-docs commit: TRANSLATIONS
- Update translation files.
2016-10-03 10:26:37 -04:00
Mrt134
473257fc7b Update client handbook with trueos-docs commit: Issue resolution and other small changes
- maintain parity with trueos handbook
2016-10-03 10:24:39 -04:00
Mrt134
6f2fe69a80 Update Life Preserver "Replication" section to warn about snapshot frequency.
- Added additional bullet point to the list of snapshot requirements for configuring replication.
- Updated translation files.
2016-09-29 13:47:48 -04:00
mrt134
512092be71 SysAdm Client Handbook Update (Firewall Manager)
- Add new section for Firewall Manager.
- Add screenshot of manager interface.
- Write full walkthrough of the interface.
- Update translation files.
2016-09-21 16:54:51 -04:00
Kris Moore
2380a15a3d Add i18n stuff for sysadm handbooks 2016-09-16 13:42:13 -04:00
Mrt134
2de60fc3df Update sysadm client:
- Add new section for "Service Manager"
- Update all screenshots to be properly captioned.
- Add screenshot for the service manager.
- A few minor whitespace and wording fixes.
2016-09-15 13:37:07 -04:00
Mrt134
1149f0b365 API update: Guide up to date 9/13/16
- Add new class to API reference guide: firewall.
- Add all new actions to firewall class.
- Format code blocks and text descriptions.
2016-09-13 13:00:47 -04:00
Mrt134
3ee59ea0cc Small fix to references:
- Fixed some broken references in TrueOS handbook due to trademark symbols.
- Ported changes back to this handbook to ensure parity; no build errors created.
2016-09-13 10:48:33 -04:00
Mrt134
cf42180fbd Full review of sysadmclient.rst
- Whitespace fixes.
- Clean up unnecessary sentence fragments.
- Add guilabel roles.
- Grammar and spelling rewrites.
- PEP8 fixes.
- Trademark substitutions added.
- Added TODO comments for screenshots which require an update or new screenshot.
- Rewrote internal references to be external. The sysadm client file should now be completely agnostic, and able to be copy/pasted between the TrueOS handbook and SysAdm client handbook.
2016-09-13 10:31:42 -04:00
Mrt134
68e8bb16bb Add substitutions patch to conf.py for all handbooks. 2016-09-08 12:44:59 -04:00
Mrt134
5e60b7479c Update sysadmclient.rst
- Fix build errors related to internal references to the TrueOS handbook.
  Internal references have been replaced with links to specific sections of the
  online trueos handbook.
- Fix PEP8 errors and a few unfinished sentences.
- Rework introduction slightly to reference the server handbook and note the
  remote access elements are disabled by default.
2016-09-06 13:39:38 -04:00
Mrt134
d29ad39e78 Merge sysadmclient.rst from trueos-docs repo into sysadm client handbook
- Copy over sysadmclient.rst from trueos-docs repo and reconfigure index and conf files to incorporate the file.
- Add all required images for sysadmclient.rst.
2016-09-06 12:09:25 -04:00
Mrt134
49fb902581 Review server handbook:
- Rewrite Introduction section for clarity.
- Add references to other SysAdm handbooks.
- Fix whitespace issues in all files.
- Fix numerous errors in all files.
- Add note about the current WIP nature of SysAdm.
- Add note listing current default ports SysAdm needs to be opened for remote access to work.
  Also noted the user can redefine which ports SysAdm uses.
2016-09-06 10:57:30 -04:00
Mrt134
f5d9caefed Update API reference, client, and server handbooks
- Edited link colors to be a stronger blue/red color.
- Altered hover role for links to add underlining to the link texts.
- Restyled roles
  - Unified padding boxes and colors (exception: :guilabel: uses a different color).
    All roles should now have the same height padding, which has been reduced as well.
  - Role colors have all been lightened to avoid being distracting or making
    contained text hard to read.
  - Removed bold from :menuselection:.
  - :command: now renders as a monospace font.
- Restyled admonitions
  - Darkened text inside admonition boxes.
  - Rounded border elements around boxes.
  - Reworked borders to be smaller and darker in color.
- Fixed figure captions to be smaller and fit better with the surrounding text.
- Restyled tables
  - Table captions now have the same style as figure captions.
  - Altered color for headers
  - Added hover themeing for tables: mousing over a row or header title will change its color.
2016-09-01 13:37:37 -04:00
Mrt134
cc1c83be7b API Reference Guide update:
- Add new class file: services.rst.
- Update all API calls to current: Aug 30,2016
2016-08-30 14:39:37 -04:00
Mrt134
65037a300c Finish in-depth review of API Guide:
- Line by line review of all .rst files in the API Reference Guide.
- Fix whitespace issues.
- Fix numerous spelling and grammar errors.
- Reworked numerous sections for clarity and flow.
- Fixed oversize tables to be fully PEP8 compliant.
2016-08-25 13:42:30 -04:00
Mrt134
7ec47963ac Begin in-depth review of API Reference guide.
- Whitespace fixes.
- Reworking text.
- Reducing the size of tables for better PEP8 conformity.
- Altering admonition box titles (use tip and danger).
- Update roles (use :guilabel: and verify other uses).
2016-08-24 15:57:57 -04:00
Mrt134
cf4a485382 Style and arrow patch update + general review of API and Server handbooks.
- Updated trueos_style to current.
- Updated menuselection arrow replacement patch to current.
- Reviewed API reference guide:
  - Reviewed for :guilabel: additions.
  - Added missing trademark symbols.
- Update Server handbook:
  - Added missing trademaks.
  - Replaced outdated link.
  - Updated admonition boxes.
  - Added :guilabel: role where necessary.
  - Add more descriptive text of SysAdm and the goals of the project.
  - Updated code-boxes.
2016-08-24 13:13:57 -04:00
Mrt134
9ed043f0f5 Add reworked theme values and apply menuselection arrow patch to all handbooks. 2016-08-23 13:52:55 -04:00
Mrt134
38eb34625e :guilabel: directive change to all handbooks
- Fixed themeing slightly for :guilabel: directives.
2016-08-22 10:17:12 -04:00
Mrt134
e530a797f7 Organization update 2:
- Moved API docs to general "docs" folder; all handbooks are now in the same area.
- Deleted "pcbsd_style" from all three handbooks as it is now trueos_style.
- Fixed a number of themeing elements for server and client handbooks.
- Added logos to both handbooks.
2016-08-18 12:26:45 -04:00
Mrt134
e47ef0915e Accidental add of _build files:
Removed _build/ files which were accidentally added to the last commit.
2016-08-18 12:04:58 -04:00
Mrt134
7c73b6a282 Handbook logisitics:
- Created client handbook and started applying themeing to it.
- Moved docs files to new folder to clearly label server and client handbooks.
2016-08-18 12:02:33 -04:00
Mrt134
a5c3e7b8b6 Update qt5 required modules and github links
- Removed two qt5 modules which are no longer required to build sysadm.
- Updated github links to reflect migration from PC-BSD to TrueOS.
2016-08-02 10:53:14 -04:00
Mrt134
4bf475bdc6 SysAdm PEP8 Conversion
- Converted SysAdm Server Handbook to PEP8 standards.
- Converted SysAdm API Handbook to PEP8 standards.
2016-07-05 18:26:39 -04:00
Tim Moore II
5da15e8f0f SysAdm Introduction addition
- Continued work on the Sysadm introduction section
2016-06-14 10:13:33 -04:00
Mrt134
d935b7b441 Syntax fix
- Updated bridge initialization commands to reflect new syntax
- fixed a make error in conf.py
2016-06-03 10:39:17 -04:00
Mrt134
e184d4b9d6 Updated "starting sysadm" section
- Updated Starting SysAdm section to reflect current instructions
- Fixed a couple grammar and spelling errors in the Bridge Initialization section
2016-06-02 15:02:17 -04:00
Mrt134
4a51c050d4 Rework bridge initialization
- Reworked bridge initialization section for clarity
- fixed a css error in the handbook theme
2016-06-02 14:30:23 -04:00
Mrt134
2f5321ea75 Sysadm server handbook section addition
- Added WIP section "Bridge System Initialization" to server handbook
- Divided instructions into two methods - one for complete ground up and another for allowing user access to an established network.
- Began clarifying and testing instructions.
2016-05-31 15:03:32 -04:00
Mrt134
df5c7c3373 bugfix in theme stylesheet
-fixed a highlighting bug
-moved 'themes' directory for simpler access
2016-05-16 14:28:37 -04:00
Mrt134
01c37a00cb Style updates
- Replaced pcbsd_style.css with the universal for both server and API handbooks
2016-05-13 11:14:45 -04:00