Skip to content

docs(update): custom scripts docs update #10125

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

Merged
merged 2 commits into from
Nov 13, 2024
Merged

docs(update): custom scripts docs update #10125

merged 2 commits into from
Nov 13, 2024

Conversation

mmrraju
Copy link
Contributor

@mmrraju mmrraju commented Nov 12, 2024

Prepare


Description

Target issue

closes #issue-number-here

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

Signed-off-by: mmrraju <mrraju.ice.iu@gmail.com>
Copy link

dryrunsecurity bot commented Nov 12, 2024

DryRun Security Summary

This pull request updates the README.md file in the "docs/janssen-server/developer/scripts" directory to correct the links and references to the custom script type documentation files, which are now located in the "../../../script-catalog/" directory, improving the organization and accessibility of the information.

Expand for full summary

Summary:

This pull request contains a documentation update to the README.md file located in the "docs/janssen-server/developer/scripts" directory. The changes focus on updating the links and references to various custom script type documentation files to ensure they point to the correct locations.

Previously, the links in the README.md file were referencing the script type documentation files directly in the same directory. The updated links now point to the script type documentation files located in the "../../../script-catalog/" directory, which is the correct relative path.

From an application security perspective, this change does not introduce any significant security implications. It is a documentation update that improves the organization and accessibility of the custom script type information, which is an important aspect of secure application development. Keeping the documentation up-to-date and easily accessible helps developers understand the available custom script types and their corresponding documentation, which can contribute to the overall security of the application.

Files Changed:

  • docs/janssen-server/developer/scripts/README.md: This file has been updated to include the correct relative paths to the various custom script type documentation files located in the "../../../script-catalog/" directory. The previous links were pointing to the script type documentation files directly in the same directory as the README.md, which has been corrected.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@mmrraju mmrraju requested review from ossdhaval and mzico November 12, 2024 17:04
@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs labels Nov 12, 2024
@mo-auto mo-auto enabled auto-merge (squash) November 12, 2024 17:11
@mo-auto mo-auto merged commit 91385d2 into main Nov 13, 2024
1 check passed
@mo-auto mo-auto deleted the mmrraju-patch-12-24 branch November 13, 2024 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants