Portn 3648 scab docs

[sivanel97]

Description

Updated the documentation to have SCAB as default in the explanations.

[notion-workspace[bot]]

SCAB docs

[aws-amplify-eu-west-1[bot]]

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2815.d2ngvl90zqbob8.amplifyapp.com

[hadar-co]

/improve

[qodo-code-review[bot]]

You are above your monthly Qodo Merge usage quota. For more information, please visit here.

[hadar-co]

/improve

[qodo-code-review[bot]]

You are above your monthly Qodo Merge usage quota. For more information, please visit here.

[hadar-co]

/improve

[qodo-code-review[bot]]

You are above your monthly Qodo Merge usage quota. For more information, please visit here.

[hadar-co]

/improve

[qodo-code-review[bot]]

PR Code Suggestions ✨

Category	Suggestion	Impact
Organization best practice	Add alt text to image Add descriptive alt text to the image to improve accessibility and follow the images guideline. docs/scorecards/concepts-and-structure.md [401] -<img src='/img/software-catalog/scorecard/catalogRuleSummaries.png' width='100%' border='1px' /> +<img src='/img/software-catalog/scorecard/catalogRuleSummaries.png' alt='Catalog rule summaries showing microservice compliance percentages' width='100%' border='1px' /> [ ] Apply / Chat Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Images should use full path links, include alt text, and define width and border.	Low
Organization best practice	Add alt text to image Add descriptive alt text to the image to improve accessibility and clarity. docs/scorecards/concepts-and-structure.md [376] -<img src='/img/software-catalog/scorecard/tutorial/ScorecardsTab.png' width='100%' border='1px' /> +<img src='/img/software-catalog/scorecard/tutorial/ScorecardsTab.png' alt='Scorecards tab showing rule results for an entity' width='100%' border='1px' /> [ ] Apply / Chat Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Use full path links for images and ensure alt text is included for accessibility.	Low
General	Correct malformed API instruction Correct a grammatical error in the API usage instructions by moving a period from after the URL to the end of the sentence. docs/scorecards/manage-scorecards.md [271] -2. Make a PUT request to the URL `https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards`. to multiple scorecards at once +2. Make a PUT request to the URL `https://api.getport.io/v1/blueprints/{blueprint_identifier}/scorecards` to update multiple scorecards at once. [To ensure code accuracy, apply this suggestion manually] Suggestion importance[1-10]: 4 __ Why: The suggestion correctly identifies a grammatical error where a period is misplaced inside a sentence but after a code-formatted URL. The fix improves the clarity and professionalism of the documentation.	Low
	Normalize property naming Remove the leading space from the Rules passed property name in the scorecard structure table to ensure consistent formatting with Rules tested. docs/scorecards/concepts-and-structure.md [30-31] | `Rules tested` | Number ([aggregation](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/aggregation-property)) | Number of [rule](#rule-elements) evaluations performed. | -|` Rules passed` | Number ([aggregation](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/aggregation-property)) | Number of successful [rule](#rule-elements) evaluations. | +| `Rules passed` | Number ([aggregation](/build-your-software-catalog/customize-integrations/configure-data-model/setup-blueprint/properties/aggregation-property)) | Number of successful [rule](#rule-elements) evaluations. | [ ] Apply / Chat Suggestion importance[1-10]: 3 __ Why: The suggestion correctly identifies and fixes a minor formatting inconsistency in a markdown table by removing a leading space from Rules passed, improving documentation quality and consistency.	Low
General	✅ Clarify relation vs property usage Suggestion Impact: The committed docs kept using "property" for fields like is_production and on_call, and "relation" for team, demonstrating and clarifying correct usage in the examples. This aligns with the suggestion to ensure consistency. code diff: -```json showLineNumbers -{ - "identifier": "ownership", - "title": "Ownership", - "filter": { - "combinator": "and", - "conditions": [ - { - "property": "is_production", - "operator": "=", - "value": true - } - ] - }, - "rules": [ - { - "title": "Has on call?", - "identifier": "has_on_call", - "level": "Gold", - "query": { - "combinator": "and", - "conditions": [ - { - "operator": "isNotEmpty", - "property": "on_call" - }, - { - "operator": "<", - "property": "open_incidents", - "value": 5 - } - ] - } - }, - { - "title": "Has a team?", - "identifier": "has_team", - "level": "Silver", - "query": { - "combinator": "and", - "conditions": [ - { - "operator": "isNotEmpty", - "relation": "team" - } - ] - } - } Verify that the usage of property and relation keys in the scorecard examples is correct and consistent with the schema, as there appears to be a discrepancy with other parts of the documentation. docs/scorecards/examples.md [25-91] { "identifier": "ownership", "title": "Ownership", "filter": { - "combinator": "and", - "conditions": [ - { - "property": "is_production", - "operator": "=", - "value": true - } - ] + "combinator": "and", + "conditions": [ + { + "property": "is_production", + "operator": "=", + "value": true + } + ] + }, + "rules": [ + { + "title": "Has on call?", + "identifier": "has_on_call", + "level": "Gold", + "query": { + "combinator": "and", + "conditions": [ + { + "operator": "isNotEmpty", + "property": "on_call" + }, + { + "operator": "<", + "property": "open_incidents", + "value": 5 + } + ] + } }, - "rules": [ - { - "title": "Has on call?", - "identifier": "has_on_call", - "level": "Gold", - "query": { - "combinator": "and", - "conditions": [ - { - "operator": "isNotEmpty", - "property": "on_call" - }, - { - "operator": "<", - "property": "open_incidents", - "value": 5 - } - ] - } - }, - { - "title": "Has team?", - "identifier": "has_team", - "level": "Silver", - "query": { - "combinator": "and", - "conditions": [ - { - "operator": "isNotEmpty", - "relation": "team" - } - ] - } + { + "title": "Has team?", + "identifier": "has_team", + "level": "Silver", + "query": { + "combinator": "and", + "conditions": [ + { + "operator": "isNotEmpty", + "relation": "team" + } + ] } + } ], "levels": [ - { - "color": "paleBlue", - "title": "Basic" - }, - { - "color": "bronze", - "title": "Bronze" - }, - { - "color": "silver", - "title": "Silver" - }, - { - "color": "gold", - "title": "Gold" - } + { "color": "paleBlue", "title": "Basic" }, + { "color": "bronze", "title": "Bronze" }, + { "color": "silver", "title": "Silver" }, + { "color": "gold", "title": "Gold" } ] } [Suggestion processed] Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a potential point of confusion regarding the use of property versus relation in query conditions. By asking for verification and consistency, it encourages clearer documentation, which is valuable for users, even though no code change is proposed.	Medium
	Fix inconsistent property casing In the scorecard structure table, change the property name Blueprint to blueprint to be consistent with other lowercase property names like identifier. docs/scorecards/concepts-and-structure.md [27] -| `Blueprint` | String (format: blueprints) | The target blueprint whose entities will be evaluated. | +| `blueprint` | String (format: blueprints) | The target blueprint whose entities will be evaluated. | [ ] Apply / Chat Suggestion importance[1-10]: 4 __ Why: The suggestion correctly identifies an inconsistency in property name casing within a table, which can be confusing for users. While the proposed fix only addresses one property, it improves local consistency and highlights a valid documentation quality issue.	Low
Organization best practice	Make link text descriptive Replace the vague link text with a descriptive phrase that clearly indicates the destination. docs/scorecards/manage-scorecards.md [363] -[Dive into advanced operations on Scorecards with our API ➡️ ](/api-reference/port-api) +[Advanced scorecard operations API reference](/api-reference/port-api) [To ensure code accuracy, apply this suggestion manually] Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Use consistent, descriptive link text and avoid vague phrasing.	Low
[ ] Update