Commit Graph

16 Commits

Author SHA1 Message Date
Mrt134
6efbf5871e API reference guide addition:
- Added missing "run" action to dispatcher class.
2016-12-08 09:55:21 -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
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
Kris Moore
2380a15a3d Add i18n stuff for sysadm handbooks 2016-09-16 13:42:13 -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
68e8bb16bb Add substitutions patch to conf.py for all handbooks. 2016-09-08 12:44:59 -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