Docsets for Offline DevCentral
Problem this snippet solves:
Unofficial DevCentral Offline docsets
Contents
This archive contains the DevCentral wiki for
- APM (dash feed)
- AdvDesignConfig (dash feed)
- BIGIQ (dash feed)
- DevOps (dash feed)
- TMSH (dash feed)
- WebAccelerator (dash feed)
- iApp (dash feed)
- iCall (dash feed)
- iControl (dash feed)
- iControlREST (dash feed)
- iHealth (dash feed)
- iRules (dash feed)
- iRulesLX (dash feed)
- iWorkflow (dash feed)
Note: github.com and devcentral.f5.com do not render the raw dash-feed:// links in this list. use the tinyurl.com [dash feed] links to redirect to the proper URL. tinyurl.com does not guarantee these URLs will remain the same, so use sane precautions.
captured in 22 March 2017.
How to use this snippet:
Usage
These docsets are compatible with docset readers such as:
for Mac, Kapeli Dash for Windows, Velocity for Linux, Zeal
Installation
Once you have your docset reader of choice installed, simply unpack the docsets and follow your reader's documentation for loading local files. I recommend adding both the Tcl 8.4 docset as they can be very useful to have to hand.
Dash
Click on each link in the list of available docsets to add the docset feed to your Dash. Go to the Downloads tab and download each docset you're interested in.
Tip: you can customise the shortcuts for Dash docsets by opening Dash, going into preferences (
cmd-commaEdit KeywordVelocity
Download all the
.docset.tgzdocsetsNavigate to Add/Download Docsets, select XCode, then press Import. Open each
.docset.tgzBackground
These docsets are created for convenience and offline use. They are fast, searchable resources covering the DevCentral API documentation for various F5 technologies.
The docsets I personally use are the ones that see the most love, iRules, iApps and iControlREST.
I only periodically update the docsets, typically when major changes appear in DevCentral. While feedback is very welcome, and changes may be included in future versions, this is not my day-job, and is not at all managed by the DevCentral team.
Your milage may vary, particularly in city use versus highway.
These docsets are only tested by me on my Mac using Dash, though they get a lot of use there.
License
The contents of this file are subject to the "END USER LICENSE AGREEMENT FOR F5 Software Development Kit for iControl"; you may not use this file except in compliance with the License. The License is included in the iControl Software Development Kit.
Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.
The Original Code is iControl Code and related documentation distributed by F5.
The Initial Developer of the Original Code is F5 Networks, Inc. Seattle, WA, USA. Portions created by F5 are Copyright (C) 1996-2017 F5 Networks, Inc. All Rights Reserved. iControl (TM) is a registered trademark of F5 Networks, Inc.
Alternatively, the contents of this file may be used under the terms of the GNU General Public License (the "GPL"), in which case the provisions of GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL and not to allow others to use your version of this file under the License, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under either the License or the GPL.
Code :
https://github.com/f5devcentral/f5-offline-dc-docsets
Tested this on version:
13.0
