-
Notifications
You must be signed in to change notification settings - Fork 274
Large docs update #346
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Large docs update #346
Conversation
* First pass of docs editing * More edits
… into docs/refactor
[skip ci]
6cd1afc to
ff26156
Compare
| For more instructions on how to bring your own certificates, please see: https://docs.splunk.com/Documentation/Splunk/latest/Security/ConfigureSplunkforwardingtousesignedcertificates | ||
| Fore further instructions, see [Configure Splunk forwarding to use your own certificates](https://docs.splunk.com/Documentation/Splunk/latest/Security/ConfigureSplunkforwardingtousesignedcertificates). | ||
|
|
||
| ## Build from source |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we should move this to CONTRIBUTING.md? I think we might want to tailor this ADVANCED.md section to outline/detail individual features of the Docker image and how it can be used by the end user.
Building images is more of a developer workflow, and the majority of end users should not need to know how to build everything from scratch (hopefully, assuming we've done our jobs in delivering a usable image :P)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docs/refactor branch name is a bit of a misnomer here. I really only edited for content and clarity rather than the architecture of the docs, which is the next step. A bunch of sections definitely need to be shuffled around.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that it needs to be separated out based on users and use cases, and I'll tackle that on the next go around. 🔨
f83a8c4 to
8136212
Compare
Fixed formatting and broken navigation
Updated language for clarity and concision