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: correct typos in scim docs #9013

Merged
merged 4 commits into from
Jul 25, 2024
Merged

docs: correct typos in scim docs #9013

merged 4 commits into from
Jul 25, 2024

Conversation

Rehket
Copy link
Contributor

@Rehket Rehket commented Jul 22, 2024

Prepare


Description

The scim portion of the documentation has some grammatical and spelling errors.

The pull request includes corrections for the misspelled words and fixes for the grammar.

Target issue

#9012

closes #9012

Implementation Details

This is an change to the documentation.

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.

Copy link

dryrunsecurity bot commented Jul 22, 2024

DryRun Security Summary

The pull request focuses on improving the documentation for the SCIM implementation in the Janssen Server, including rephrasing sentences, improving formatting, and expanding abbreviations, without introducing any new security risks or vulnerabilities.

Expand for full summary

Summary:

The code changes in this pull request primarily focus on improving the documentation for the SCIM (System for Cross-domain Identity Management) implementation in the Janssen Server. The changes include rephrasing sentences, improving formatting, and expanding abbreviations in the documentation files. Additionally, there are updates to the documentation for customizing SCIM attributes and the SCIM bulk users endpoint.

From an application security perspective, the changes do not introduce any new security risks or vulnerabilities. The documentation updates are focused on improving clarity and accuracy, without modifying any underlying code. However, it's important to note that the SCIM specification and its implementation are security-critical, as they deal with the exchange of user identity information across different domains. Proper configuration and adherence to the SCIM specification are crucial for ensuring the overall security of the Janssen Server's identity management system.

Files Changed:

  1. docs/admin/scim/README.md: The changes in this file primarily focus on improving the clarity and readability of the SCIM documentation, such as rephrasing sentences and formatting the list of RFC references.

  2. docs/admin/scim/custom-attributes.md: The changes in this file correct the term "objectclass" to "object class" and update the image file name "scim-extention" to "scim-extension" to reflect the correct spelling.

  3. docs/admin/scim/bulk-users.md: The changes in this file provide more details and examples around the SCIM bulk users endpoint, which allows for multiple user creation, modification, or deletion operations in a single request. The documentation highlights the importance of proper security measures, such as limiting the number of operations and payload size, as well as the need for appropriate authentication and authorization.

Code Analysis

We ran 9 analyzers against 3 files and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@ossdhaval ossdhaval self-requested a review July 24, 2024 03:00
@ossdhaval
Copy link
Contributor

Hi @Rehket

Thank you for coming forward and making this contribution 👍

Two things that come to my notice are:

  • PR is coming from main branch of the fork. Good practise it to use a feature branch and avoid working directly on main.
  • When you raise a PR, check if all the PR checks are passing. It takes couple of minutes to complete all the checks. Once you see all the checks are through, then request for review.

Overall, the code changes that you have made look good. 💯

@Rehket
Copy link
Contributor Author

Rehket commented Jul 24, 2024

Thanks for the feedback @ossdhaval, I will be working through feature branches going forward.

@ossdhaval ossdhaval merged commit 634e380 into JanssenProject:main Jul 25, 2024
11 checks passed
yuriyz pushed a commit that referenced this pull request Nov 7, 2024
* docs: correct typos in scim docs

* docs: correct typos in scim docs

Signed-off-by: Rehket <aalbright425@gmail.com>

---------

Signed-off-by: Rehket <aalbright425@gmail.com>
Co-authored-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
Former-commit-id: 634e380
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.

docs: correct typos and grammar in docs/scim
3 participants