1.. pop-config documentation master file, created by
2   sphinx-quickstart on Wed Mar 11 13:52:53 2020.
3   You can adapt this file completely to your liking, but it should at least
4   contain the root `toctree` directive.
5
6======================
7Welcome to pop-config
8======================
9
10``pop-config`` is a core component of POP and a key part of POP's ability to "app merge" applications.
11
12The word "config" has a lot of different meanings depending on context, so it's important that we
13clarify the capabilities of ``pop-config``. In the world of POP, think of
14"config" as referring to *command-line arguments for a program*, *plus a bunch of other cool
15functionality related to command-line arguments*. It might be best to pretend ``pop-config`` is
16actually named ``pop-args``. This would be a more accurate name and better convey its functionality.
17
18The reason why the name ``pop-config`` is used may be that ``pop-config`` has a lot of very
19useful functionality, and taken as a whole, can often be used to manage the entire configuration
20of your application. For example, ``pop-config`` allows you to:
21
22* Define command-line arguments for your application.
23* Optionally set these command-line arguments via environment variables.
24* Optionally source these command-line arguments from a file.
25* Merge in plugins which augment the command-line arguments of your application.
26
27The important thing to keep in mind is that all this functionality is *argument-centric*, and
28yes, many applications will find their configuration needs fully satisfied by ``pop-config``.
29
30But it's really ``pop-args`` :) Just keep that in the back of your head. It will help.
31
32
33
34
35.. toctree::
36   :maxdepth: 2
37   :glob:
38
39   topics/pop-config
40   tutorial/index
41   releases/index
42
43.. toctree::
44   :caption: Get Involved
45   :maxdepth: 2
46   :caption: Contents:
47
48   topics/introduction
49   topics/config
50   topics/cli_config
51   topics/subcommands
52   topics/advanced
53   topics/merging
54   topics/contributing
55   topics/license
56   Project Repository <https://gitlab.com/saltstack/pop/pop-create/>
57
58Indices and tables
59==================
60
61* :ref:`genindex`
62* :ref:`modindex`
63* :ref:`search`
64