Skip to content

US Region Docs Update#89

Merged
taherkk merged 3 commits intomainfrom
us-region-update
Mar 3, 2026
Merged

US Region Docs Update#89
taherkk merged 3 commits intomainfrom
us-region-update

Conversation

@paulo-gomes-sg
Copy link
Copy Markdown
Collaborator

@paulo-gomes-sg paulo-gomes-sg commented Jan 29, 2026

Update docs to display the correct url for stackguardian API and for the US region

Copy link
Copy Markdown
Collaborator

@taherkk taherkk left a comment

Choose a reason for hiding this comment

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

Run make docs-generate

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to update documentation to inform users about the US region endpoint. However, it introduces critical bugs by incorrectly modifying nested schema documentation paths.

Changes:

  • Added comment to API URI configuration examples to indicate the US region endpoint alternative (https://api.us.stackguardian.io)
  • Modified nested schema headers in documentation files (incorrectly changing them from config to attribute names like source_config_dest_kind and source_config_kind)

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/index.md Added helpful comment about US region API endpoint
docs/guides/Installation.md Updated API URI with US region information and corrected from test API to production API
docs-templates/index.md.tmpl Added US region comment to template file
docs-templates/guides/Installation.md Updated template with US region information and corrected from test API to production API
docs/resources/policy.md INCORRECTLY changed nested schema path from config to source_config_dest_kind
docs/resources/connector.md INCORRECTLY changed nested schema path from config to source_config_dest_kind
docs/data-sources/policy.md INCORRECTLY changed nested schema path from config to source_config_kind
docs/data-sources/connector.md INCORRECTLY changed nested schema path from config to source_config_dest_kind

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


<a id="nestedatt--discovery_settings--benchmarks--runtime_source--config"></a>
### Nested Schema for `discovery_settings.benchmarks.runtime_source.config`
### Nested Schema for `discovery_settings.benchmarks.runtime_source.source_config_dest_kind`
Copy link

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

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

The nested schema path is incorrect. This header should describe the schema for the config attribute, not source_config_dest_kind. The correct header should be: ### Nested Schema for discovery_settings.benchmarks.runtime_source.config

The source_config_dest_kind is a sibling attribute at the same level as config, not a nested schema. Looking at line 74, you can see that config is defined as an Attributes object with its own nested schema, and that's what this section should document. This same pattern is correctly followed in other files like docs/resources/runner_group.md at line 87.

Suggested change
### Nested Schema for `discovery_settings.benchmarks.runtime_source.source_config_dest_kind`
### Nested Schema for `discovery_settings.benchmarks.runtime_source.config`

Copilot uses AI. Check for mistakes.

<a id="nestedatt--policies_config--policy_vcs_config--custom_source--config"></a>
### Nested Schema for `policies_config.policy_vcs_config.custom_source.config`
### Nested Schema for `policies_config.policy_vcs_config.custom_source.source_config_kind`
Copy link

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

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

The nested schema path is incorrect. This header should describe the schema for the config attribute, not source_config_kind. The correct header should be: ### Nested Schema for policies_config.policy_vcs_config.custom_source.config

The source_config_kind is a sibling attribute at the same level as config, not a nested schema. Looking at line 86, you can see that config is defined as an Attributes object with its own nested schema, and that's what this section should document. This same pattern is correctly followed in other files like docs/resources/runner_group.md at line 87.

Suggested change
### Nested Schema for `policies_config.policy_vcs_config.custom_source.source_config_kind`
### Nested Schema for `policies_config.policy_vcs_config.custom_source.config`

Copilot uses AI. Check for mistakes.
@taherkk taherkk changed the title US Region Update US Region Docs Update Mar 3, 2026
@taherkk taherkk merged commit 9071ce3 into main Mar 3, 2026
1 of 4 checks passed
@taherkk taherkk deleted the us-region-update branch March 3, 2026 08:41
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.

4 participants