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

docs: Configure options of jsonschema docs, formatting output #2270

Merged
merged 3 commits into from
Jan 17, 2023

Conversation

echoix
Copy link
Collaborator

@echoix echoix commented Jan 17, 2023

This is a change extracted from the branch now in https://github.com/oxsecurity/megalinter/tree/dev/multi-platform-images (at https://github.com/oxsecurity/megalinter/tree/e223a1a9a0539b3f76da8614ab4b22cb876f3643).
It is to reduce the diff of the branch with main when we will want to merge it.

Proposed Changes

  1. Set config option minify to false: the diff between generations will only be the time generated at the end of the file if there are no changes.
  2. Set link_to_reused_ref to false: The details of definition will be repeated instead of jumping to somewhere at the other end of the file
  3. Set the expand_buttons to false. It is the default value, but a reminder to explore if it pleasant to use. I remember trying it out and didn't like it. The docs of JSON Schema for humans use it here https://coveooss.github.io/json-schema-for-humans/examples/examples_js_default/Configuration.html

Readiness Checklist

Author/Contributor

  • Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

@echoix echoix added the documentation Improvements or additions to documentation label Jan 17, 2023
@echoix echoix marked this pull request as ready for review January 17, 2023 03:01
@echoix echoix requested a review from nvuillam as a code owner January 17, 2023 03:01
@codecov-commenter
Copy link

Codecov Report

Merging #2270 (b086a7b) into main (8b1ed86) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2270      +/-   ##
==========================================
+ Coverage   82.41%   82.43%   +0.02%     
==========================================
  Files         171      171              
  Lines        4520     4520              
==========================================
+ Hits         3725     3726       +1     
+ Misses        795      794       -1     
Impacted Files Coverage Δ
megalinter/reporters/UpdatedSourcesReporter.py 89.74% <0.00%> (+2.56%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@nvuillam nvuillam left a comment

Choose a reason for hiding this comment

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

Great, thanks a lot :)

@nvuillam nvuillam merged commit 8b00741 into oxsecurity:main Jan 17, 2023
@echoix echoix deleted the feature/json-schema-formatting branch January 17, 2023 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants