diff --git a/.claude/commands/release-note-developer.md b/.claude/commands/release-note-developer.md index 8b11cce1d06..73f66e249e4 100644 --- a/.claude/commands/release-note-developer.md +++ b/.claude/commands/release-note-developer.md @@ -1,6 +1,6 @@ # Create New Developer Release Note -Automates the creation of Developer release notes for APIs, SDKs, integrations, and platform changes relevant to developers. +Automates the creation of Developer release notes for APIs, integrations, and platform changes relevant to developers. ## What this command does @@ -15,7 +15,6 @@ When you invoke `release-note-developer`, Claude will guide you through: * Announcing new API endpoints or features * Documenting API changes, deprecations, or breaking changes -* Publishing SDK updates or new SDK versions * Releasing developer tools or CLI updates * Announcing platform changes affecting developers * Documenting authentication or integration changes @@ -26,7 +25,6 @@ When you invoke `release-note-developer`, Claude will guide you through: Developer release notes typically cover: * **APIs**. New endpoints, changes, deprecations -* **SDKs**. New SDKs, version updates, improvements * **CLI**. Command-line tool updates * **Integrations**. New integrations or integration changes * **Platform**. Platform changes affecting developers @@ -72,7 +70,6 @@ blog-developer/YYYY-MM-DD-{slug}.md Examples: * `blog-developer/2026-03-23-api-endpoints.md` * `blog-developer/2026-04-09-india-datacenter-deprecation.md` -* `blog-developer/2026-05-15-python-sdk-v2.md` **Important**: Files are created in `/blog-developer/` directory (root level, no subdirectories) @@ -106,7 +103,6 @@ hide_table_of_contents: true * **Always ask user if they want to include keywords** * Suggest keywords based on content type: * API changes: `api`, `endpoints`, `rest-api` - * SDK updates: `sdk`, `python`, `java`, etc. * Deprecations: `deprecation`, `end-of-life` * Breaking changes: `breaking-change` * Platform updates: `platform`, `datacenter` @@ -130,8 +126,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; **Title guidelines:** * Keep concise (2-5 words) * Use title case -* Common patterns: "APIs", "SDKs", "CLI Tools", "Platform Updates" -* Can be more specific: "Python SDK", "REST API", "Management APIs" +* Common patterns: "APIs", "CLI Tools", "Platform Updates" +* Can be more specific: "REST API", "Management APIs" ### Step 5: Write content @@ -184,42 +180,6 @@ We're excited to announce new API endpoints for managing Field Extraction Rules **Monitors API**: The `notificationGroupFields` parameter is now required when creating monitors. Update your integrations before June 1, 2026. See the [Monitors API documentation](/docs/api/monitors) for details. ``` -#### SDK Updates - -For SDK releases: -* Version number -* What's new or changed -* Installation instructions -* Link to SDK docs or GitHub - -**Example:** -```markdown ---- -title: March 23, 2026 - Python SDK Version 2.0 -image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082 -hide_table_of_contents: true -keywords: - - sdk - - python ---- - -We've released version 2.0 of the Sumo Logic Python SDK with support for the latest APIs and improved error handling. - -#### What's new - -* Support for Field Extraction Rules API -* Async client support for better performance -* Improved error messages and debugging - -#### Installation - -```python -pip install sumologic-sdk==2.0.0 -``` - -Learn more in the [Python SDK documentation](/docs/api/python-client). -``` - #### Deprecations For deprecation notices: @@ -305,7 +265,7 @@ Before finishing, verify: * [ ] Content is clear and includes relevant links * [ ] Breaking changes are clearly marked (use bold or H4 sections) * [ ] Documentation links use relative paths (start with `/docs/`) -* [ ] Keywords added if applicable (deprecation, api, sdk, etc.) +* [ ] Keywords added if applicable (deprecation, api, etc.) * [ ] No trailing whitespace ## Example usage @@ -483,12 +443,6 @@ Would you like me to help refine the content or add additional details? * Provide migration path with examples * Offer support contact for questions -**For SDK releases:** -* Include version number prominently -* Show installation/upgrade commands -* Highlight breaking changes separately -* Link to changelog or GitHub release - **All release notes:** * Write for developers (assume technical knowledge) * Focus on impact and action items diff --git a/docs/api/about-apis/terraform-with-sumo-logic.md b/docs/api/about-apis/terraform-with-sumo-logic.md index aad5d6d73ec..bc6abec701d 100644 --- a/docs/api/about-apis/terraform-with-sumo-logic.md +++ b/docs/api/about-apis/terraform-with-sumo-logic.md @@ -161,7 +161,7 @@ Perform the following steps to use the template: 1. [Install Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) (version 1.6 or later). 1. [Install Python](https://www.python.org/downloads/) (version 3.11 or later). 1. [Install the latest version of the "jq" JSON parser](https://github.com/jqlang/jq/wiki/Installation), necessary to run the `.sh` batch files in the template. - 1. [Install the Sumo Logic Python SDK](https://pypi.org/project/sumologic-sdk/). + 1. [Install the Sumo Logic Python SDK](https://pypi.org/project/sumologic-sdk/). This is a community-supported package; Sumo Logic doesn't take support tickets for it. 1. [Install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). 1. Next, navigate to the `sumologic-solution-templates` folder where you cloned the repository, and go to the `aws-observability-terraform` subdirectory. Set this directory to be the Terraform working directory by executing the following command: `terraform init` 1. Using the solution template starts with [the main.auto.tfvars file](https://github.com/SumoLogic/sumologic-solution-templates/blob/master/aws-observability-terraform/main.auto.tfvars) which contains variable settings for your Sumo Logic organization, access ID and key, and other configuration information that will be referenced by the other template files. Open this file and fill in each field with the requested information.
tfvars file
Check the [Sumo Logic API endpoints](/docs/api/about-apis/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security) if you need help finding the proper deployment value to use. diff --git a/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md b/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md index 76b17b18f2e..3840008478d 100644 --- a/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md +++ b/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md @@ -82,7 +82,7 @@ Before you run the Terraform script, perform the following actions on a server m ```bash jq --version ``` -1. Install Sumo Logic Python SDK using the following command. Click [here](https://pypi.org/project/sumologic-sdk/) to learn more. +1. Install Sumo Logic Python SDK using the following command. This is a community-supported package; Sumo Logic doesn't take support tickets for it ([learn more](https://pypi.org/project/sumologic-sdk/)). ```bash pip install sumologic-sdk ```