Merge pull request #25 from StackExchange/feat/stack-internal-rebrand

chore: rebranding patch (Stack Internal)

Author: EstoesMoises

.changeset/tired-sites-trade.md

@@ -0,0 +1,7 @@
+---
+'@stackoverflow/backstage-stack-overflow-teams-collator': patch
+'@stackoverflow/backstage-plugin-stack-overflow-teams-backend': patch
+'@stackoverflow/backstage-plugin-stack-overflow-teams': patch
+---
+
+Rebranding patch, changed terms from "Stack Overflow for Teams" to "Stack Overflow Internal" or "Stack Internal"

Dockerfile

@@ -1,7 +1,7 @@
 # DO NOT USE THIS IN PRODUCTION
 # 
 # This Dockerfile builds a Docker image for a pre-configured Backstage instance
-# with the Stack Overflow plugins installed. It’s designed as a quick way to try 
+# with the Stack Overflow Internal plugins installed. It’s designed as a quick way to try 
 # out the integration without having to set it up yourself. 
 #
 # This is not intended for production use.

README.md

@@ -1,31 +1,31 @@
-# Backstage - Stack Overflow for Teams Plugin
+# Backstage - Stack Internal Plugin
 
 ## Overview
 
-The **Stack Overflow for Teams** plugins for **Backstage** integrate your private knowledge solution with your Backstage instance. These plugins provide seamless access to **Stack Overflow Teams'** most relevant data, allowing you to display the top users, top tags, and top questions directly within Backstage. Additionally, it indexes all the questions from a Stack Overflow instance and integrates them into Backstage search, providing enhanced discoverability.
+The **Stack Internal** plugins for **Backstage** integrate your private knowledge solution with your Backstage instance. These plugins provide seamless access to **Stack Internal'** most relevant data, allowing you to display the top users, top tags, and top questions directly within Backstage. Additionally, it indexes all the questions from a Stack Internal instance and integrates them into Backstage search, providing enhanced discoverability.
 
-These plugins also allow you to securely create **Stack Overflow for Teams** questions from Backstage itself.
+These plugins also allow you to securely create **Stack Internal** questions from Backstage itself.
 
 ## Key Features
 
 ### OAuth Authentication
 
-The plugin uses OAuth authentication to ensure that only authorised users can post questions to your Stack Overflow instance from Backstage. The OAuth process is secure, user-friendly, and integrates seamlessly with Backstage, providing a safe way to verify user identities before allowing access to question creation features.
+The plugin uses OAuth authentication to ensure that only authorised users can post questions to your Stack Internal instance from Backstage. The OAuth process is secure, user-friendly, and integrates seamlessly with Backstage, providing a safe way to verify user identities before allowing access to question creation features.
 
 ### Top Users and Tags
-Displays the top users and tags from your Stack Overflow instance, giving you insights into the most active contributors and trending topics.
+Displays the top users and tags from your Stack Internal instance, giving you insights into the most active contributors and trending topics.
 
 <img width="2260" height="1264" alt="image" src="https://github.com/user-attachments/assets/a28f5380-f9f8-453a-b60e-855c02c45f38" />
 <img width="449" height="316" alt="Screenshot 2025-08-05 at 23 14 15" src="https://github.com/user-attachments/assets/64fbb6bf-b1fd-422b-8be6-7b5b1a2d5483" />
 
 
 ### Question Indexing
-Retrieves all the questions from your Stack Overflow instance and indexes them into Backstage search. This makes it easier to search and discover questions across your organisation.
+Retrieves all the questions from your Stack Overflow Internal instance and indexes them into Backstage search. This makes it easier to search and discover questions across your organisation.
 
 ![alt text](https://i.imgur.com/HLKNAZb.png)
 
-### Stack Overflow Hub
-A centralised hub within Backstage that showcases the top questions. The hub also allows you to filter questions like you would on Stack Overflow.
+### Stack Overflow Internal Hub
+A centralised hub within Backstage that showcases the top questions. The hub also allows you to filter questions like you would on Stack Overflow Internal.
 
 <img width="2269" height="1260" alt="image" src="https://github.com/user-attachments/assets/da2059ec-3507-4b2c-86c4-ce799d2d4d67" />
 
@@ -42,7 +42,7 @@ If you’d like to quickly see how this integration works without setting up you
 
 **`estoesmoises/stackoverflow-backstage-demo:latest`**
 
-This image runs a Backstage instance pre-configured with the Stack Overflow for Teams plugin. You just need to pass a few environment variables when starting the container to connect it to your Stack Overflow for Teams instance.
+This image runs a Backstage instance pre-configured with the Stack Internal plugin. You just need to pass a few environment variables when starting the container to connect it to your Stack Internal instance.
 
 ---
 
@@ -52,26 +52,26 @@ This image runs a Backstage instance pre-configured with the Stack Overflow for
 
 | Variable                          | Description                                                                                                                                                                                                                                                                                        |
 | :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `STACK_OVERFLOW_INSTANCE_URL`     | The base URL of your Stack Overflow for Teams (Enterprise) instance.                                                                                                                                                                                                                               |
-| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Overflow Enterprise instance. This token is used by the plugin’s search collator to index questions into Backstage search.                                                                                                    |
-| `STACK_OVERFLOW_CLIENT_ID`        | The OAuth Client ID from your Stack Overflow application. This is required to enable the secure question creation flow from within Backstage.                                                                                                                                                      |
-| `STACK_OVERFLOW_REDIRECT_URI`     | The redirect URI where Stack Overflow should send users after completing the OAuth authentication flow. By default, this is `{app.baseUrl}/stack-overflow-teams`. For local development, you can use a redirect service like `http://redirectmeto.com/http://localhost:7007/stack-overflow-teams`. |
+| `STACK_OVERFLOW_INSTANCE_URL`     | The base URL of your Stack Internal (Enterprise) instance.                                                                                                                                                                                                                               |
+| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Internal Enterprise instance. This token is used by the plugin’s search collator to index questions into Backstage search.                                                                                                    |
+| `STACK_OVERFLOW_CLIENT_ID`        | The OAuth Client ID from your Stack Overflow Internal application. This is required to enable the secure question creation flow from within Backstage.                                                                                                                                                      |
+| `STACK_OVERFLOW_REDIRECT_URI`     | The redirect URI where Stack Overflow Internal should send users after completing the OAuth authentication flow. By default, this is `{app.baseUrl}/stack-overflow-teams`. For local development, you can use a redirect service like `http://redirectmeto.com/http://localhost:7007/stack-overflow-teams`. |
 
 ---
 
 ### For **Basic** and **Business** Customers:
 
 | Variable                          | Description                                                                                                              |
 | :-------------------------------- | :----------------------------------------------------------------------------------------------------------------------- |
-| `STACK_OVERFLOW_TEAM_NAME`        | The **team name** or **team slug** from your Stack Overflow for Teams account.                                           |
-| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Overflow Teams instance. Used for indexing content. |
+| `STACK_OVERFLOW_TEAM_NAME`        | The **team name** or **team slug** from your Stack Internal account.                                           |
+| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Internal instance. Used for indexing content. |
 
 > **Note:**  
 > Question creation is **not supported** on the **Basic** tier.
 
 📖 How to generate your API Access Token
 
-Basic and Business customers can follow the official Stack Overflow for Teams guide to create a Personal Access Token (PAT) for API authentication:
+Basic and Business customers can follow the official Stack Internal guide to create a Personal Access Token (PAT) for API authentication:
 
 👉 [Personal Access Tokens (PATs) for API Authentication](https://stackoverflowteams.help/en/articles/10908790-personal-access-tokens-pats-for-api-authentication)
 

packages/app/src/components/Root/Root.tsx

@@ -80,7 +80,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
         <SidebarItem
           icon={StackOverflowIcon}
           to="stack-overflow-teams"
-          text="Stack Overflow"
+          text="Stack Overflow Internal"
         />
         <SidebarItem
           icon={StackOverflowIcon}

packages/backend/sample.env

@@ -1,5 +1,5 @@
 STACK_OVERFLOW_INSTANCE_URL=https://[your-site]/api/v3
-# This token doesn't needd scope=write_access, this is only use to create an index of all the questions of your Stack Overflow instance.
+# This token doesn't needd scope=write_access, this is only use to create an index of all the questions of your Stack Overflow Internal instance.
 STACK_OVERFLOW_API_ACCESS_TOKEN=
 # API Application must have read-write permissions, please provide the application's id.
 STACK_OVERFLOW_CLIENT_ID=

plugins/README.md

@@ -1,15 +1,15 @@
 
 
 
-# Stack Overflow for Teams Plugins for Backstage
+# Stack Internal Plugins for Backstage
 
 
 
-Based on the existing [**Community Plugins**](https://github.com/backstage/community-plugins/tree/main/workspaces/stack-overflow/plugins) for Stack Overflow, this version introduces two new plugins:
+Based on the existing [**Community Plugins**](https://github.com/backstage/community-plugins/tree/main/workspaces/stack-overflow/plugins) for Stack Overflow Internal, this version introduces two new plugins:
 
-- A **frontend plugin** responsible for displaying Stack Overflow for Teams data.
+- A **frontend plugin** responsible for displaying Stack Internal data.
 
-- A **backend plugin** responsible for fetching and creating Stack Overflow for Teams data.
+- A **backend plugin** responsible for fetching and creating Stack Internal data.
 
 
 
@@ -35,7 +35,7 @@ Displays information about the authenticated user.
 
 -  **`<StackOverflowPostQuestionModal />`**
 
-Provides a form for users to create a new Stack Overflow question. Once submitted, an API request is executed to create the question.
+Provides a form for users to create a new Stack Overflow Internal question. Once submitted, an API request is executed to create the question.
 
 
 
@@ -71,7 +71,7 @@ Initiates **`/auth/start`** on the backend.
 
 -  **`<StackAuthCallback />`**
 
-Receives the code and state from your Stack Overflow Enterprise instance as part of the OAuth process and initiates **`/callback`** in the backend.
+Receives the code and state from your Stack Internal Enterprise instance as part of the OAuth process and initiates **`/callback`** in the backend.
 
 
 
@@ -107,9 +107,9 @@ The **Backstage backend plugin** (the **Teams plugin**) is responsible for:
 
 
 
--  **Indexing all questions** from the private Stack Overflow instance (an enhanced version of the existing community plugins in the Backstage repository).
+-  **Indexing all questions** from the private Stack Overflow Internal instance (an enhanced version of the existing community plugins in the Backstage repository).
 
--  **Handling API requests** via ``createStackOverflowApi`` and ``createStackOverflowService`` to the Stack Overflow instance for retrieving:
+-  **Handling API requests** via ``createStackOverflowApi`` and ``createStackOverflowService`` to the Stack Overflow Internal instance for retrieving:
 
 -  `/users`
 
@@ -119,15 +119,15 @@ The **Backstage backend plugin** (the **Teams plugin**) is responsible for:
 
 - Posting new questions via `/questions`
 
--  **Managing OAuth authentication flow** to securely access Stack Overflow. via ``createStackOverflowAuth``
+-  **Managing OAuth authentication flow** to securely access Stack Overflow Internal. via ``createStackOverflowAuth``
 
 
 
 ## OAuth Authentication Flow
 
 
 
-The backend is the only component that directly utilizes **Stack Overflow access tokens** for requests.
+The backend is the only component that directly utilizes **Stack Overflow Internal access tokens** for requests.
 
 
 
@@ -151,8 +151,8 @@ The backend is the only component that directly utilizes **Stack Overflow access
 
 - Retrieves the stored **Code Verifier** and **State**.
 
-- Validates that the received **state** matches the one from Stack Overflow's query string parameter.
+- Validates that the received **state** matches the one from Stack Overflow Internal's query string parameter.
 
 - The backend requests an **Access Token** using the stored **Code Verifier**.
 
-- Stores the **Stack Overflow Access Token** in a **secure, HTTP-only cookie**.
+- Stores the **Stack Overflow Internal Access Token** in a **secure, HTTP-only cookie**.

plugins/search-backend-module-stack-overflow-teams-collator/README.md

@@ -1,7 +1,7 @@
 
-# Stack Overflow for Teams Search Backend Module
+# Stack Internal Search Backend Module
 
-This module for the search plugin is an enhanced version of the original [Stack Overflow collator](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-stack-overflow-collator). It provides additional information while coded to work specifically with Stack Overflow for Teams API Version 3.
+This module for the search plugin is an enhanced version of the original [Stack Overflow Internal collator](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-stack-overflow-collator). It provides additional information while coded to work specifically with Stack Internal API Version 3.
 
 ## Getting started
 
@@ -13,24 +13,24 @@ To use any of the functionality this plugin provides, you need to start by confi
 
 ```yaml
 stackoverflow:
-  baseUrl: https://api.stackoverflowteams.com # alternative: your Stack Overflow Enterprise site
+  baseUrl: https://api.stackoverflowteams.com # alternative: your Stack Internal Enterprise site
   teamName: $STACK_OVERFLOW_TEAM_NAME # optional if you are on Enterprise
   apiAccessToken: $STACK_OVERFLOW_API_ACCESS_TOKEN
 ```
 
-### Stack Overflow for Teams
+### Stack Internal
 
-If you have a private Stack Overflow instance and/or a private Stack Overflow Team you will need to supply a Personal Access Token. You can read more about how to set this up by going to [Stack Overflow's Help Page](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
+If you have a private Stack Overflow Internal instance and/or a private Stack Overflow Internal Team you will need to supply a Personal Access Token. You can read more about how to set this up by going to [Stack Overflow Internal's Help Page](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
 
 ## Areas of Responsibility
 
-This stack overflow backend plugin is primarily responsible for the following:
+This Stack Overflow Internal backend plugin is primarily responsible for the following:
 
-- Provides a `StackOverflowQuestionsCollatorFactory`, which can be used in the search backend to index stack overflow questions to your Backstage Search.
+- Provides a `StackOverflowQuestionsCollatorFactory`, which can be used in the search backend to index Stack Overflow Internal questions to your Backstage Search.
 
-### Index Stack Overflow Questions to search
+### Index Stack Overflow Internal Questions to search
 
-Before you are able to start index stack overflow questions to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).
+Before you are able to start index Stack Overflow Internal questions to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).
 
 When you have your `packages/backend/src/plugins/search.ts` file ready to make modifications, add the following code snippet to add the `StackOverflowQuestionsCollatorFactory`. Note that you can optionally modify the `requestParams`, otherwise it will defaults to `{ order: 'desc', sort: 'activity' }`.
 
@@ -49,7 +49,7 @@ indexBuilder.addCollator({
 
 ## New Backend System
 
-This package exports a module that extends the search backend to also indexing the questions exposed by the [`Stack Overflow for Teams API version 3`](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
+This package exports a module that extends the search backend to also indexing the questions exposed by the [`Stack Internal API version 3`](https://stackoverflowteams.help/en/articles/7913768-stack-overflow-for-teams-api-v3).
 
 ### Installation
 

plugins/search-backend-module-stack-overflow-teams-collator/config.d.ts

@@ -16,22 +16,22 @@
 
 export interface Config {
     /**
-     * Configuration options for the stack overflow plugin
+     * Configuration options for the Stack Overflow Internal plugin
      */
     stackoverflow?: {
       /**
-       * The base url of the Stack Overflow API used for the plugin, if no BaseUrl is provided it will default to https://api.stackoverflowteams.com
+       * The base url of the Stack Overflow Internal API used for the plugin, if no BaseUrl is provided it will default to https://api.stackoverflowteams.com
        */
       baseUrl?: string;
 
       /**
-       * The API Access Token to authenticate to Stack Overflow API Version 3
+       * The API Access Token to authenticate to Stack Overflow Internal API Version 3
        * @visibility secret
        */
       apiAccessToken: string;
 
       /**
-       * The name of the team for a Stack Overflow for Teams account. When teamName is provided baseUrl will always be https://api.stackoverflowteams.com
+       * The name of the team for a Stack Internal account. When teamName is provided baseUrl will always be https://api.stackoverflowteams.com
        */
       teamName?: string;
 

plugins/search-backend-module-stack-overflow-teams-collator/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stackoverflow/backstage-stack-overflow-teams-collator",
   "version": "1.5.0",
-  "description": "A module for the search backend that exports stack overflow for teams modules",
+  "description": "A module for the search backend that exports Stack Internal modules",
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "search",