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

NH-39805 README and CONFIGURATION updates #70

Merged
merged 2 commits into from
Sep 18, 2023
Merged

Conversation

cheempz
Copy link
Contributor

@cheempz cheempz commented Sep 6, 2023

Main changes are revamping the documentation pages, which will be customer facing once repo is made public and be primary until the SWO docs site is updated:

  • Renamed CONFIG to CONFIGURATION and updated to reflect current state of configuration options
  • Moved content from README to CONFIGURATION and CONTRIBUTING
  • Added custom instrumentation section to README

Misc changes:

  • install libyaml in the dev docker for pysch gem's extension to compile
  • minor Rakefile updates for more diagnostic output

Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

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

Rubocop found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

@xuan-cao-swi xuan-cao-swi force-pushed the NH-39805-update-readme branch from 1a9e14b to a3ad2d2 Compare September 8, 2023 15:32
@cheempz cheempz marked this pull request as ready for review September 14, 2023 00:51
@cheempz cheempz requested review from xuan-cao-swi and a team September 14, 2023 00:51
@cheempz cheempz merged commit 381433a into main Sep 18, 2023
11 of 12 checks passed
@cheempz cheempz deleted the NH-39805-update-readme branch September 18, 2023 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants