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

Doc fixes logging config #1585

Merged
merged 1 commit into from
Nov 16, 2022

Conversation

reubenmiller
Copy link
Contributor

@reubenmiller reubenmiller commented Nov 14, 2022

Proposed changes

Update Cumulocity log management documentation to fix various paths and typos. The following items were corrected:

Docs: Cumulocity log management

  • Fix reference to c8y-log-plugin.toml (a unit test was also updated to use correct configuration file name to avoid confusion with the documentation)
  • Fix example mosquitto log file path
  • Fix path to software management log files in the logging example
  • Remove c8y_LogRequest from example as the log files are not currently used

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Copy link
Member

@rina23q rina23q left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc change of c8y-log-plugin.toml is very nice, thanks for catching them. However, the change of the c8y-configuration-management doc must be reverted. Therefore, I block merging.

docs/src/references/c8y-configuration-management.md Outdated Show resolved Hide resolved
Signed-off-by: Reuben Miller <reuben.miller@softwareag.com>
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

docs/src/references/c8y-log-management.md Show resolved Hide resolved
@reubenmiller reubenmiller merged commit d28a1a8 into thin-edge:main Nov 16, 2022
@reubenmiller reubenmiller deleted the doc-fixes-logging-config branch November 16, 2022 10:37
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.

None yet

4 participants