Skip to content

Commit

Permalink
Minor doc typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
lowell80 committed Feb 28, 2019
1 parent fbf699e commit d7c31cc
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/source/cmd_rest-export.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ksconf rest-export

You should consider using :ref:`ksconf_cmd_rest-publish` instead of this one.
The only remaining valid use case for ``rest-export`` (this command) is for disconnected scenarios.
In other words, if you need to push stanzas to a splunkd instance where you don't (an can't) install ``ksconf``,
In other words, if you need to push stanzas to a splunkd instance where you don't (and can't) install ``ksconf``,
then this command may still be useful to you.
In this case, ``ksconf rest-export`` can create a shell script that you can transfer to the correct network,
and then run the shell script.
Expand Down
1 change: 1 addition & 0 deletions docs/source/dyn/ksconf_subcommands.csv
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
:ref:`ksconf minimize <ksconf_cmd_minimize>`,beta,Minimize the target file by removing entries duplicated in the default conf(s)
:ref:`ksconf promote <ksconf_cmd_promote>`,beta,"Promote .conf settings between layers using either either in batch mode (all changes) or interactive mode. Frequently this is used to promote conf changes made via the UI (stored in the ``local`` folder) to a version-controlled directory, often ``default``. "
:ref:`ksconf rest-export <ksconf_cmd_rest-export>`,beta,Export .conf settings as a curl script to apply to a Splunk instance later (via REST)
:ref:`ksconf rest-publish <ksconf_cmd_rest-publish>`,alpha,Publish .conf settings to a live Splunk instance via REST
:ref:`ksconf snapshot <ksconf_cmd_snapshot>`,alpha,Snapshot .conf file directories into a JSON dump format
:ref:`ksconf sort <ksconf_cmd_sort>`,stable,Sort a Splunk .conf file creating a normalized format appropriate for version control
:ref:`ksconf unarchive <ksconf_cmd_unarchive>`,beta,Install or upgrade an existing app in a git-friendly and safe way
8 changes: 3 additions & 5 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,16 +174,14 @@ The output should look something like this:
### ## ##### ###### ##### ### ## ##
#

ksconf 0.7.0rc1 (Build 313)
ksconf 0.7.0 (Build 320)
Python: 2.7.15 (/Applications/splunk/bin/python)
Git SHA1 9b43d302 committed on 2019-02-26
Git SHA1 fbf699e3 committed on 2019-02-27
Installed at: /Applications/splunk/etc/apps/ksconf/bin/lib/ksconf
Written by Lowell Alleman <lowell@kintyre.co>.
Copyright (c) 2019 Kintyre Solutions, Inc, all rights reserved.
Licensed under Apache Public License v2

kintyre_splunk_conf (0.6.3rc2-py2.7)

Commands:
check (stable) OK
combine (beta) OK
Expand All @@ -198,7 +196,6 @@ The output should look something like this:
sort (stable) OK
unarchive (beta) OK


Missing 3rd party libraries
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -211,6 +208,7 @@ Any value other than 'OK' indicates a problem.
Here's an example of the output if you're missing the ``splunk-sdk`` package.

::

...
promote (beta) OK
rest-export (beta) OK
Expand Down

0 comments on commit d7c31cc

Please sign in to comment.