Commit Graph

141 Commits

Author SHA1 Message Date
Mrt134
dd34a97f57 Update API guide to current 8/18/16
- Modified "usershow" action to add "canremove": "false".
- Added new "groupmod" action with examples.
2016-08-18 09:58:03 -04:00
Mrt134
4e6f1f79d2 Update API handbook
- Added all missing API calls and updates from mid-June to current.
- Pared down several tables closer to PEP8 sizing.
2016-08-16 11:36:39 -04:00
Mrt134
81aedaaaab Add trueos_style, sysadm icon, and handbook name change.
- Added trueos_style to themes/
- Added sysadm_circle_red.png
- Edited conf.py:
  - Use trueos_style for html builds.
  - Use sysadm_circle_red.png as the sidebar logo.
  - Altered handbook name to "SysAdm API reference guide".
2016-08-15 11:21:18 -04:00
Mrt134
fbc436db75 Fix all Sphinx build errors with API handbook
- Fixed every sphinx build error for JSON parsing.
- For invalid JSON messages, replaced .. code-block:: JSON with the
  generic code block directive ::.
- Fixed multiple errors across various valid JSON code blocks.
- Fixed a few spacing errors with .. note:: entries.
2016-08-04 15:01:15 -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
Mrt134
18e61346b6 Refinement to connection.rst &
-Further refined connection.rst to explain the encryption elements to the SSL certificate authentication initiation
2016-05-26 09:35:50 -04:00
Mrt134
65f8f7f747 Added initial examples of client-bridge-server ssl authentication to api handbook (api/connection.rst)
- added #4 to section 1.1 Authentication: SSL Certificate Initiation
- provided examples of an initial request and reply
- added notation to identify at which point messages become encrypted
2016-05-25 10:22:31 -04:00
Mrt134
d216ad5c2b Additional documentation for SSL certificate management
- Added json code blocks for websocket requests and responses of ssl certificate actions
- Style tweaks
2016-05-17 11:31:45 -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
Mrt134
a9ce5ad765 Added pcbsd_theme 2016-05-12 16:07:42 -04:00
Mrt134
1a45554b8a Update API with Bridge
- Identified server, client or bridge websocket requests
- Added Bridge subsystem section with json example
2016-05-12 16:05:25 -04:00
dlavigne
97695ef4f1 Doc list_ssl_checksums. 2016-05-05 10:19:12 -04:00
dlavigne
0f9a73de2f Add identify RPC call. 2016-05-03 14:20:44 -04:00
dlavigne
52d599dc82 Doc the namespace change of the sysadm/logs class to rpc/logs. 2016-04-29 11:06:53 -04:00
dlavigne
85ffdab597 Doc kill action. 2016-04-29 11:03:52 -04:00
dlavigne
b473ea7314 Add new dispatcher class. 2016-04-29 10:59:16 -04:00
dlavigne
3131b73a5e Add new logs class. While here, fix a grammo. 2016-04-28 09:13:58 -04:00
dlavigne
1d041b47f9 Update name of Guide. While here, fix a mangled table. 2016-04-27 14:37:39 -04:00
dlavigne
fe58a46838 Doc pkg_autoremove action. 2016-04-27 09:34:06 -04:00
Ken Moore
cd3078c708 Add a note about the day-codes for the lifepreserver scrub schedule: 01 is Monday, 07 is Sunday. 2016-04-26 13:45:45 -04:00
dlavigne
0cd90b3558 Doc new fs class. 2016-04-22 12:29:56 -04:00
dlavigne
cf1c16de27 Doc datasets action. 2016-04-21 13:45:16 -04:00
dlavigne
25eac09ce9 Doc createsnap action. 2016-04-21 13:37:59 -04:00
Tim Moore II
81c4e91905 Content addition to connection.rst
-beginning to create content for the "getting started" section in connection.rst
-re-added events.rst to the index
-some json syntax corrections in connection.rst
2016-04-12 16:47:30 -04:00
Tim Moore II
224c7c8178 Additional dispatcher work
-updated dispatcher messaging to reflect current changes
-fixed some errors in formatting
-altered dispatcher sample responses in the necessary classes section to reflect a "finished" state.
2016-04-12 13:39:34 -04:00
Tim Moore II
e245ee9be4 Events.rst work
-Adding additional documentation of dispatcher subsystem and sample code blocks
2016-04-07 14:56:20 -04:00
Tim Moore II
6cdd3d2cbf A few error fixes
- updated sysadm server documentation with correct title.
 - cleaned up a few json errors in dispatcher event reply messages.
2016-03-31 13:54:26 -04:00
Tim Moore II
b7be4faa31 Merge branch 'master' of https://github.com/pcbsd/sysadm 2016-03-29 16:23:59 -04:00
Tim Moore II
9a371de28d Working on section 3 of PC-BSD API 1.0 documentation.
Added subsections to section 3: dispatcher, life preserver, and system state.
Added examples of dispatcher messaging to parts of section 4: Classes.
Added further examples of messaging to section 3 in the subsections.
2016-03-29 16:17:26 -04:00
dlavigne
f66656675b Remove placeholders for now as they can be readded as calls are created. 2016-03-29 10:21:18 -04:00
dlavigne
6705c0b70c Remove redundancy. Events will now be described in each section, as required. 2016-03-29 10:06:52 -04:00
dlavigne
842a594ce3 Doc extra arguments to pkg_info. 2016-03-28 14:08:53 -04:00
dlavigne
d68499f0e4 Doc pkg_remove action. 2016-03-28 13:25:40 -04:00
dlavigne
89bf8df311 Doc pkg_install action. 2016-03-28 13:04:50 -04:00
dlavigne
f72f2db240 doc pkg_lock and pkg_unlock actions. 2016-03-28 12:51:22 -04:00
dlavigne
6e046d5782 Doc pkg_update action. 2016-03-28 12:40:37 -04:00
dlavigne
069e0467a4 Doc pkg_check_upgrade action. 2016-03-28 12:28:51 -04:00
dlavigne
dd19b3cf88 Doc pkg_upgrade action. 2016-03-28 11:47:58 -04:00
dlavigne
7aa65f4d22 Doc the pkg_audit action. 2016-03-28 11:40:38 -04:00
dlavigne
5d7bd03cc1 Doc list_categories and list_repos actions. 2016-03-28 11:22:32 -04:00
dlavigne
34dcdf1aef Doc pkg_info action. 2016-03-28 10:39:55 -04:00
dlavigne
428e8d93b0 Prep for changes to pkg class. 2016-03-28 10:23:34 -04:00
dlavigne
8119f440a5 Doc setprop action. 2016-03-28 10:01:41 -04:00
dlavigne
85de30526f Doc getprops action. 2016-03-28 09:50:29 -04:00
Ken Moore
9934a17450 Update zfs.rst
This accounts for the change to the JSON output of a sysadm/zfs "list_pools" action.
2016-03-22 09:47:28 -04:00
dlavigne
9ae2bac697 Clarify resize limitation. 2016-03-03 15:32:53 -05:00
dlavigne
32a662c47d Doc version command. 2016-03-03 15:23:00 -05:00
dlavigne
31a4424b26 Doc resizedisk action. 2016-03-03 15:17:28 -05:00
dlavigne
1edaf3ff6e Doc deletedisk action. 2016-03-03 13:49:57 -05:00