docs: reorganize quickstart and home pages #1393
Conversation
|
All contributors have NOT signed the CLA Document I have read the CLA Document and I hereby accept the CLA 2 out of 4 committers have signed the CLA. |
| If you use Windows, ... | ||
| If you use macOS, ...<!--- Artem to give more info---> |
There was a problem hiding this comment.
@kkedziak-splunk please provide the command on how to initialize the virtualenv.
Co-authored-by: Artem Rys <[email protected]>
docs/commands.md
Outdated
|
|
||
| Apart from standard files needed for the add-on, it also adds search head | ||
| clustering files in the `default/server.conf` file and reload triggers in the | ||
| `default/app.conf` file. Those files will be soon <!--- verb is missing ---> by generated automatically by the |
There was a problem hiding this comment.
Those files will be soon <!--- verb is missing ---> by generated automatically by the ucc-gen build command itself. @artemrys what will happen the files?
There was a problem hiding this comment.
I think "generated", it's just an extra "by" there.
docs/dot_conf_files.md
Outdated
| Also the `triggers` stanza is created by `ucc-gen`. It <!--- it stands for stanza or ucc-gen---> determines what | ||
| the `.conf` files are used in the add-on and generates the relevant key-value |
There was a problem hiding this comment.
@artemrys In this sentence: "It determines what the .conf files are used..." does "It" stands for stanza or ucc-gen?
There was a problem hiding this comment.
Yes, UCC (as a framework) or to be more specific ucc-gen build as a specific command.
| * it possibly extends the UI with custom codes (for more information, see [here](custom_ui_extensions/custom_hook.md)). | ||
| * it possibly extends the build process via a `additional_packaging.py` file (more information, [here](additional_packaging.md)). | ||
| * generates the necessary files defined for the Alert Action, if defined in globalConfig (for more informaiton, see [here](alert_actions/index.md)). | ||
| ## What UCC generates |
There was a problem hiding this comment.
I added the caveats as a note in this section. @artemrys do we leave this info here?
There was a problem hiding this comment.
Yes, let's leave it for now, that's not a deal breaker for me.
Issue number: https://splunk.atlassian.net/browse/ADDON-68816
Summary
Changes
User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.