Skip to content
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

[fix] logging docu: splunk config and indentation of example code #3457

Merged
merged 1 commit into from
Sep 15, 2021

Conversation

papanito
Copy link
Contributor

The splunk configuration was wrong as splunkHec starts with lower s.
Also fields are hec_host and hec_port.

When contributing to docs, please don't update the content in the v2.x folder.
It's better to update the versioned docs, for example, the v2.5 or v2.6 docs.

This content in v2.x was separated into versioned documentation during the v2.5.8
release. The content relevant to Rancher versions before v2.5 went into the v2.0-v2.4
folder, while the content related to Rancher v2.5 went into the v2.5 folder.

We are trying to get the 2.x content to be removed from Google search results. The only
reason we haven't deleted it is because Google search results would lead to 404
errors if we deleted it.

The splunk configuration was wrong as `splunkHec` starts with lower `s`.
Also fields are `hec_host` and `hec_port`.
@papanito papanito changed the title [fix] indentation and splunk config [fix] logging docu: splunk config and indentation of example code Aug 22, 2021
@ansilh
Copy link
Contributor

ansilh commented Aug 23, 2021

The doc on the banzai side is autogenerated vi acode and looks like the mistake started from there.

@ansilh ansilh requested a review from catherineluse August 23, 2021 05:14
@ansilh
Copy link
Contributor

ansilh commented Aug 23, 2021

Let's merge this PR and keep Rancher docs accurate.
Sure, you can submit a PR in logging operator upstream too.

@papanito
Copy link
Contributor Author

@ansilh
Copy link
Contributor

ansilh commented Aug 23, 2021

Thanks @papanito
Was there any reason not to change splunkHec (starting with small "s" instead of caps) in the upstream?

@papanito
Copy link
Contributor Author

Nope I guess I missed that. Will fix it...

@papanito
Copy link
Contributor Author

papanito commented Sep 2, 2021

@catherineluse anything missing?
Btw. I assume now that you have 2.6 docu it should also go there?

@catherineluse catherineluse requested review from btat and removed request for catherineluse September 10, 2021 21:16
@catherineluse
Copy link
Contributor

@papanito Yes, if it's valid for Rancher 2.6 it should go in the 2.6 directory.

@catherineluse catherineluse added this to the v2.6.1 milestone Sep 12, 2021
@papanito
Copy link
Contributor Author

I will create a separate PR for 2.6.x but I guess would not hurt to also update 2.5.x docu ;-)

@btat
Copy link
Contributor

btat commented Sep 15, 2021

Merging and will use https://github.com/rancher/docs/issues/3520 for tracking of the 2.6 port

@btat btat merged commit 666782c into rancher:master Sep 15, 2021
@papanito papanito deleted the patch-1 branch September 15, 2021 05:57
@papanito
Copy link
Contributor Author

Thanks @btat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants