diff --git a/docs/guides/access-groups.mdx b/docs/guides/access-groups.mdx index 25dfc828dac..3a071b71d63 100644 --- a/docs/guides/access-groups.mdx +++ b/docs/guides/access-groups.mdx @@ -214,7 +214,7 @@ Create a fourth policy for the same instance. - **Roles and actions** - For Platform access, select **Administrator**. Click **Next**. At the bottom, click **Add**, then click **Assign**. -Finally, add users to the access group. You can do this from the access group's **Users** page, or by using the IBM Quantum Platform [Access management](https://quantum.cloud.ibm.com/access-groups) page. +Finally, add users to the access group. You can do this from the access group's **Users** page, or by using the IBM Quantum Platform [Access management](/access-groups) page. You can only invite users who are already members of the account. If you don't see a user on the Add users page, follow the steps in [Invite and manage users](/docs/guides/invite-and-manage-users#invite) to add them to the account first. After they accept the invitation, you can add them to the access group. diff --git a/docs/guides/algorithmiq-tem.ipynb b/docs/guides/algorithmiq-tem.ipynb index 69827f22908..08b6530b810 100644 --- a/docs/guides/algorithmiq-tem.ipynb +++ b/docs/guides/algorithmiq-tem.ipynb @@ -125,7 +125,7 @@ "source": [ "## Get started\n", "\n", - "Authenticate using your [IBM Quantum Platform API key](http://quantum.cloud.ibm.com/), and select the TEM function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" + "Authenticate using your [IBM Quantum Platform API key](/), and select the TEM function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" ] }, { @@ -365,7 +365,7 @@ "\n", "\n", "\n", - "- [Request access to Algorithmiq Tensor-network error mitigation](https://quantum.cloud.ibm.com/functions?id=algorithmiq-tem)\n", + "- [Request access to Algorithmiq Tensor-network error mitigation](/functions?id=algorithmiq-tem)\n", "\n", "" ] diff --git a/docs/guides/allocation-limits.mdx b/docs/guides/allocation-limits.mdx index 4ca46d0c0ef..fd8c05b1b83 100644 --- a/docs/guides/allocation-limits.mdx +++ b/docs/guides/allocation-limits.mdx @@ -9,7 +9,7 @@ An account might have allotted time on the Premium or Flex plan. Because each ac The time that you allocate to instances is used by the fair-share algorithm to determine the priority in the queue, based on usage of all QPUs over a rolling time window of 28 days (for Premium Plan users) or over the subscription period (for Flex Plan users). -The allocation is set when creating the instance. However, you can view and change allocated time on the [instances page.](https://quantum.cloud.ibm.com/instances) +The allocation is set when creating the instance. However, you can view and change allocated time on the [instances page.](/instances) ## What happens when the limit is reached diff --git a/docs/guides/cloud-setup-invited.mdx b/docs/guides/cloud-setup-invited.mdx index 58b727ffcf1..48812090d90 100644 --- a/docs/guides/cloud-setup-invited.mdx +++ b/docs/guides/cloud-setup-invited.mdx @@ -16,7 +16,7 @@ You can run workloads on IBM® quantum processing units (QPUs) by setting up Your user account is associated with one or more [instances](./instances), identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API token (also called a key) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](./instances#connect-instance). - The [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com) and the [Instances page](https://quantum.cloud.ibm.com/instances) list the instances that you can access. + The [IBM Quantum Platform dashboard](/) and the [Instances page](/instances) list the instances that you can access. @@ -26,7 +26,7 @@ Your user account is associated with one or more [instances](./instances), ident 1. Accept the email invitation. 1. Log in with an IBMid or Google account. Note that the profile that you use to log in to IBM Cloud or IBM Quantum Platform in this step is not your IBM Cloud account. After logging in, confirm your information and accept the invitation to join the account. -1. Navigate back to [IBM Quantum Platform.](https://quantum.cloud.ibm.com) +1. Navigate back to [IBM Quantum Platform.](/) 1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image. * Choose the account that was invited in the email. * The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to. diff --git a/docs/guides/cloud-setup-rest-api.mdx b/docs/guides/cloud-setup-rest-api.mdx index 017ec4ec2c8..aec3a6bf5ca 100644 --- a/docs/guides/cloud-setup-rest-api.mdx +++ b/docs/guides/cloud-setup-rest-api.mdx @@ -12,8 +12,8 @@ You can access quantum processors with REST APIs, enabling you to work with QPUs ### 1. Get access -1. If you do not already have a user account, get one at the [IBM Quantum login page.](https://quantum.cloud.ibm.com/login) -1. Create an API key (also called a token) on the [dashboard.](https://quantum.cloud.ibm.com) Note that the same API key can be used for either region. +1. If you do not already have a user account, get one at the [IBM Quantum login page.](/login) +1. Create an API key (also called a token) on the [dashboard.](/) Note that the same API key can be used for either region. 1. Generate an IBM Cloud Identity and Access Management (IAM) bearer token. This is a short-lived token used to authenticate requests to the REST API. To generate one, call the [IAM Identity Services API](https://cloud.ibm.com/apidocs/iam-identity-token-api#create-api-key) as shown in the following sample request: diff --git a/docs/guides/cloud-setup-untrusted.mdx b/docs/guides/cloud-setup-untrusted.mdx index d08da5df4ad..fd06bd687ec 100644 --- a/docs/guides/cloud-setup-untrusted.mdx +++ b/docs/guides/cloud-setup-untrusted.mdx @@ -21,8 +21,8 @@ Follow these instructions if you are working with IBM Cloud or the IBM Qiskit Ru ## Find your access credentials -1. Find your API key (also referred to as an _API token_). From the [dashboard](https://quantum.cloud.ibm.com/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region. -2. Optional: Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. +1. Find your API key (also referred to as an _API token_). From the [dashboard](/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region. +2. Optional: Find the instance you want to use from the [Instances](/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. ## Authenticate to IBM Cloud in an untrusted environment diff --git a/docs/guides/cloud-setup.mdx b/docs/guides/cloud-setup.mdx index f15865836cd..2d7baf36b8b 100644 --- a/docs/guides/cloud-setup.mdx +++ b/docs/guides/cloud-setup.mdx @@ -19,11 +19,11 @@ Your user account is associated with one or more [instances,](./instances) ident ### Before you begin -1. If you do not already have one, set up an [IBM Cloud account.](https://quantum.cloud.ibm.com/registration) +1. If you do not already have one, set up an [IBM Cloud account.](/registration) - You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](https://quantum.cloud.ibm.com) interface. + You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](/) interface. -1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.) +1. Log in to [IBM Quantum Platform](/) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.) 1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image. The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to. @@ -33,7 +33,7 @@ Your user account is associated with one or more [instances,](./instances) ident ### 1. Create an instance -You can create an instance from the IBM Quantum Platform [Instances](https://quantum.cloud.ibm.com/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions. +You can create an instance from the IBM Quantum Platform [Instances](/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions. ### 2. Optional: Save your access credentials diff --git a/docs/guides/common-parameters.ipynb b/docs/guides/common-parameters.ipynb index 312fed73189..7c5dbaa9ea1 100644 --- a/docs/guides/common-parameters.ipynb +++ b/docs/guides/common-parameters.ipynb @@ -214,7 +214,7 @@ "id": "d2034dd5-23e5-4473-89b8-aaf4233775c7", "metadata": {}, "source": [ - "You can use the [`plot_error_map`](/docs/api/qiskit/qiskit.visualization.plot_error_map) function to generate a diagram of the device graph with error information and with the physical qubits labeled. You can also view similar diagrams on the [Compute resources](https://quantum.cloud.ibm.com/computers) page." + "You can use the [`plot_error_map`](/docs/api/qiskit/qiskit.visualization.plot_error_map) function to generate a diagram of the device graph with error information and with the physical qubits labeled. You can also view similar diagrams on the [Compute resources](/computers) page." ] }, { diff --git a/docs/guides/composer.mdx b/docs/guides/composer.mdx index bbea6252a89..fd56248497f 100644 --- a/docs/guides/composer.mdx +++ b/docs/guides/composer.mdx @@ -9,7 +9,7 @@ description: IBM Quantum Composer is a graphical programming tool. Drag and drop ## What is it? -[IBM Quantum® Composer](https://quantum.cloud.ibm.com/composer) is a graphical quantum programming tool that lets you drag and drop operations to build quantum circuits and run them on quantum hardware. +[IBM Quantum® Composer](/composer) is a graphical quantum programming tool that lets you drag and drop operations to build quantum circuits and run them on quantum hardware. ## What can it do? diff --git a/docs/guides/estimate-job-run-time.ipynb b/docs/guides/estimate-job-run-time.ipynb index 58ae25c085a..b030a25e37d 100644 --- a/docs/guides/estimate-job-run-time.ipynb +++ b/docs/guides/estimate-job-run-time.ipynb @@ -54,7 +54,7 @@ "\n", "## View instance usage\n", "\n", - "You can view an instance's usage on the [Instances](https://quantum.cloud.ibm.com/instances) page, or, for those with the proper authority, the [Analytics](https://quantum.cloud.ibm.com/analytics) page. Note that the pages might show different usage numbers because they calculate usage differently.\n", + "You can view an instance's usage on the [Instances](/instances) page, or, for those with the proper authority, the [Analytics](/analytics) page. Note that the pages might show different usage numbers because they calculate usage differently.\n", "\n", "The Instances page shows real-time usage for the last 28 days (rolling), up to the current time on the current day. The Analytics page usage is re-calculated hourly and includes the last 28 full days; that is, it shows usage from 00:00 28 days ago to today, at the top of the hour.\n", "\n", diff --git a/docs/guides/function-template-chemistry-workflow.ipynb b/docs/guides/function-template-chemistry-workflow.ipynb index 42511fa96d6..28831ebebc6 100644 --- a/docs/guides/function-template-chemistry-workflow.ipynb +++ b/docs/guides/function-template-chemistry-workflow.ipynb @@ -137,7 +137,7 @@ "source": [ "### Authentication\n", "\n", - "Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key (token), which can be found on the [IBM Quantum Platform](https://quantum.cloud.ibm.com) dashboard. This allows for the instantiation of the serverless client to upload or run the selected function:\n", + "Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key (token), which can be found on the [IBM Quantum Platform](/) dashboard. This allows for the instantiation of the serverless client to upload or run the selected function:\n", "\n", "```python\n", "from qiskit_ibm_catalog import QiskitServerless\n", diff --git a/docs/guides/function-template-hamiltonian-simulation.ipynb b/docs/guides/function-template-hamiltonian-simulation.ipynb index a0179140304..1aa32c41a10 100644 --- a/docs/guides/function-template-hamiltonian-simulation.ipynb +++ b/docs/guides/function-template-hamiltonian-simulation.ipynb @@ -586,7 +586,7 @@ "## Deploy the function to IBM Quantum Platform\n", "The previous section created a program to be run remotely. The code in this section uploads that program to Qiskit Serverless.\n", "\n", - "Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key, which you can find on the [IBM Quantum Platform](https://quantum.cloud.ibm.com) dashboard, and upload the program.\n", + "Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key, which you can find on the [IBM Quantum Platform](/) dashboard, and upload the program.\n", "\n", "You can optionally use `save_account()` to save your credentials (see the [Set up your IBM Cloud account](/docs/guides/cloud-setup#cloud-save) guide). Note that this writes your credentials to the same file as [`QiskitRuntimeService.save_account()`.](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#save_account)" ] diff --git a/docs/guides/functions.ipynb b/docs/guides/functions.ipynb index 1eb0b248d88..bbbf06d71b0 100644 --- a/docs/guides/functions.ipynb +++ b/docs/guides/functions.ipynb @@ -61,7 +61,7 @@ "\n", "### Request a free trial for third-party Qiskit Functions\n", "\n", - "To request a new free trial, navigate to the [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions), and explore the details panel. Click on `Request a free trial` and fill out information required by the Functions partner, including the IBM Cloud `AccessGroupId`:\n", + "To request a new free trial, navigate to the [Qiskit Functions Catalog](/functions), and explore the details panel. Click on `Request a free trial` and fill out information required by the Functions partner, including the IBM Cloud `AccessGroupId`:\n", "\n", "1. Navigate to [IBM Cloud IAM.](http://cloud.ibm.com/iam/groups)\n", "2. Verify eligibility.\n", @@ -80,7 +80,7 @@ " ```\n", " pip install qiskit-ibm-catalog\n", " ```\n", - "1. Retrieve your API key from the [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com/), and activate your Python virtual environment. See the [installation instructions](/docs/guides/install-qiskit#local) if you do not already have a virtual environment set up.\n", + "1. Retrieve your API key from the [IBM Quantum Platform dashboard](/), and activate your Python virtual environment. See the [installation instructions](/docs/guides/install-qiskit#local) if you do not already have a virtual environment set up.\n", "\n", " **If you are working in a trusted Python environment (such as on a personal laptop or workstation),** use the `save_account()` method to save your credentials locally. ([Skip to the next step](#functions-untrusted) if you are not using a trusted environment, such as a shared or public computer, to authenticate to IBM Quantum Platform.)\n", "\n", diff --git a/docs/guides/get-qpu-information.ipynb b/docs/guides/get-qpu-information.ipynb index 958b2ba4e05..eabc7ea6bc9 100644 --- a/docs/guides/get-qpu-information.ipynb +++ b/docs/guides/get-qpu-information.ipynb @@ -44,7 +44,7 @@ "source": [ "## List backends\n", "\n", - "To view the backends you have access to, you can either view a list on the [Compute resources page,](https://quantum.cloud.ibm.com/computers) or you can use the [`QiskitRuntimeService.backends()`](../api/qiskit-ibm-runtime/qiskit-runtime-service#backends) method. This method returns a list of [`IBMBackend`](../api/qiskit-ibm-runtime/ibm-backend) instances:\n", + "To view the backends you have access to, you can either view a list on the [Compute resources page,](/computers) or you can use the [`QiskitRuntimeService.backends()`](../api/qiskit-ibm-runtime/qiskit-runtime-service#backends) method. This method returns a list of [`IBMBackend`](../api/qiskit-ibm-runtime/ibm-backend) instances:\n", "\n", "\n", "If you are logged in to a specific instance or region, or if you initialized the service with a specific instance or region by using `QiskitRuntimeService()`, only the backends available to you on that instance or region are returned.\n", diff --git a/docs/guides/global-data-quantum-optimizer.ipynb b/docs/guides/global-data-quantum-optimizer.ipynb index a4d051ca7b2..a64c0355b41 100644 --- a/docs/guides/global-data-quantum-optimizer.ipynb +++ b/docs/guides/global-data-quantum-optimizer.ipynb @@ -448,7 +448,7 @@ "id": "5028c729-6223-4108-bc1e-1c9d95a56bd6", "metadata": {}, "source": [ - "Authenticate using your [API key](https://quantum.cloud.ibm.com/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" + "Authenticate using your [API key](/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" ] }, { diff --git a/docs/guides/ibm-circuit-function.ipynb b/docs/guides/ibm-circuit-function.ipynb index de3edf4e71d..2d496eb92d6 100644 --- a/docs/guides/ibm-circuit-function.ipynb +++ b/docs/guides/ibm-circuit-function.ipynb @@ -61,7 +61,7 @@ "id": "f46c531c", "metadata": {}, "source": [ - "Authenticate using your [API key](http://quantum.cloud.ibm.com/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" + "Authenticate using your [API key](/) and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" ] }, { diff --git a/docs/guides/index.mdx b/docs/guides/index.mdx index 94b11301f15..847b161f95a 100644 --- a/docs/guides/index.mdx +++ b/docs/guides/index.mdx @@ -78,7 +78,7 @@ pip install qiskit_serverless ## Qiskit Functions -Qiskit Functions (`qiskit-ibm-catalog.QiskitFunctionsCatalog`) are abstracted services designed to accelerate algorithm discovery and application prototyping. Explore the [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions), including: +Qiskit Functions (`qiskit-ibm-catalog.QiskitFunctionsCatalog`) are abstracted services designed to accelerate algorithm discovery and application prototyping. Explore the [Qiskit Functions Catalog](/functions), including: - **Circuit functions**: Services that include transpilation, error suppression, error mitigation, and post-processing techniques that take abstract circuits and desired measurement observables as input. With Circuit functions, users can discover new algorithms and applications without needing to manage transpilation or quantum hardware performance. - **Application functions**: Services that include entire quantum workflows, from mapping classical to quantum, optimizing for hardware, execution on hardware, and post-processing. Users can prototype industry applications with domain-familiar inputs and outputs. diff --git a/docs/guides/initialize-account.mdx b/docs/guides/initialize-account.mdx index 0f230d924b6..c390c2fadb6 100644 --- a/docs/guides/initialize-account.mdx +++ b/docs/guides/initialize-account.mdx @@ -20,7 +20,7 @@ Ensure that you have completed these steps: 1. Ensure that you are a member of an IBM Cloud account. See [Set up your IBM Cloud account](/docs/guides/cloud-setup) for instructions. 2. Create (or have access to) at least one instance. Follow these steps to verify: - 1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com). + 1. Log in to [IBM Quantum Platform](/). 1. Make sure that the correct account and region are selected in the account switcher in the header. 1. If you have one or more instances shown, you're done with this step. Otherwise, [create an instance.](/docs/guides/instances#add-instance) 1. Ensure you are working in an active Python environment with the [Qiskit SDK and Qiskit Runtime installed.](/docs/guides/install-qiskit#local) @@ -30,8 +30,8 @@ Ensure that you have completed these steps: ## Find your access credentials -1. Find your API key (also referred to as an _API token_). From the [dashboard](https://quantum.cloud.ibm.com/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region. -2. Optional: Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. +1. Find your API key (also referred to as an _API token_). From the [dashboard](/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region. +2. Optional: Find the instance you want to use from the [Instances](/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. ## Connect Qiskit with your Qiskit Runtime service instance diff --git a/docs/guides/instances.mdx b/docs/guides/instances.mdx index dfd98163b59..e9c6cf5a3a2 100644 --- a/docs/guides/instances.mdx +++ b/docs/guides/instances.mdx @@ -8,21 +8,21 @@ Access to IBM Quantum Platform services is controlled by the **instances** to wh An instance is a deployment of Qiskit Runtime. You need a different instance for every service plan (such as Open or Pay-As-You-Go) you use in every region that you want to use. The account manager and anyone with enough permission can create an instance and define its configuration, such as its allocations, usage limits, quantum computers, and user permissions. Each instance is identified by a unique Cloud Resource Name (CRN). This CRN can be used when sending workloads from your Qiskit programs. -The IBM Quantum Platform [dashboard](https://quantum.cloud.ibm.com/) displays the instances to which you have access. Depending on your access, you can view full details, edit, and delete instances on the [Instances page.](https://quantum.cloud.ibm.com/instances) +The IBM Quantum Platform [dashboard](/) displays the instances to which you have access. Depending on your access, you can view full details, edit, and delete instances on the [Instances page.](/instances) It is important that you understand which instance you are using, because all instances that are not associated with the Open Plan incur a cost. ## Open Plan instance -Open Plan users can run quantum circuits on the world's best QPUs for free (up to 10 minutes quantum time per 28-day rolling window). The QPU usage can be tracked on the [Platform dashboard](https://quantum.cloud.ibm.com/) and the [Workloads](https://quantum.cloud.ibm.com/workloads) pages. +Open Plan users can run quantum circuits on the world's best QPUs for free (up to 10 minutes quantum time per 28-day rolling window). The QPU usage can be tracked on the [Platform dashboard](/) and the [Workloads](/workloads) pages. ## Pay-As-You-Go Plan instance The Pay-As-You-Go Plan is a paid plan. To use this plan, you must create an instance and assign it to the plan. All workloads sent to QPUs by using this plan incur a charge. -The jobs you run and the jobs run by other collaborators in the same instance count toward the reported usage for that instance. You can view an instance's usage on the [Instances](https://quantum.cloud.ibm.com/instances) page, or, for those with the proper authority, the [Analytics](https://quantum.cloud.ibm.com/analytics) page. Note that the pages might show different usage numbers because the Instance page shows usage in a 28-day rolling window prior to the current timestamp, while the Analytics page uses full-day boundaries. +The jobs you run and the jobs run by other collaborators in the same instance count toward the reported usage for that instance. You can view an instance's usage on the [Instances](/instances) page, or, for those with the proper authority, the [Analytics](/analytics) page. Note that the pages might show different usage numbers because the Instance page shows usage in a 28-day rolling window prior to the current timestamp, while the Analytics page uses full-day boundaries. If an instance has been marked as "limited" by your administrator (you will see a "Remaining" column in the usage area) and the instance exceeds its allocation (defined by your administrator) within the 28-day rolling window, any active workload will continue running (including sessions) but pending workloads will remain in the queue until more time is available. If an instance is not limited and the instance exceeds its allocation, jobs run with that instance are likely to run at a lower priority and experience longer queue times. @@ -75,7 +75,7 @@ Follow these steps to create an instance and add it to your account. If you are To avoid exposure of the user's workflow data to a global Distributed Denial of Service protection layer, you can use [Virtual Private Endpoints](https://cloud.ibm.com/docs/overview?topic=overview-endpoints-support). `qiskit-ibm-runtime` supports this through the [`private_endpoint` parameter](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service). -1. From the dashboard Instances pane, click **View all**, or go to the [Instances](https://quantum.cloud.ibm.com/instances) page from the main menu. +1. From the dashboard Instances pane, click **View all**, or go to the [Instances](/instances) page from the main menu. 1. From the Instances page, click **Create instance**. * Enter a name and optionally add tags. * If you have access to more than one resource group in IBM Cloud®, you can choose to change the resource group this instance belongs to. See [Managing resource groups](https://cloud.ibm.com/docs/account?topic=account-rgs&interface=ui) and [Giving access to resources in resource groups](https://cloud.ibm.com/docs/account?topic=account-rgs_manage_access) for more information. @@ -87,11 +87,11 @@ Follow these steps to create an instance and add it to your account. If you are If you customize the allocated compute resources, the available QPUs will never be automatically updated, regardless of any changes made to the parent plan. However, you can manually add or remove QPUs later. If you do not customize them, you will always have access to any QPU to which the account has access on the plan. So if in the future there is a new QPU added to the plan, the instance automatically has access to it. 1. The Access group pane opens. A "collaborators" access group is automatically created for this instance. Users added to this access group can use the time allocated to this instance. You can [modify or create additional access groups](/docs/guides/access-groups) by using the [IBM Cloud console.](https://cloud.ibm.com/iam/groups) See [Setting up access groups](https://cloud.ibm.com/docs/account?topic=account-groups&interface=ui) for instructions. -1. Click **Create instance**. You can now view the instance on the [Instances](https://quantum.cloud.ibm.com/instances) page. If you have set up multiple plans on your account, each plan type has its own tab on the Instances table. +1. Click **Create instance**. You can now view the instance on the [Instances](/instances) page. If you have set up multiple plans on your account, each plan type has its own tab on the Instances table. ## Edit an instance and its allocation -Find the instance on the [Instances](https://quantum.cloud.ibm.com/instances) page. Click the overflow menu at the end the instance's row, and select Edit details. +Find the instance on the [Instances](/instances) page. Click the overflow menu at the end the instance's row, and select Edit details. ## Next steps diff --git a/docs/guides/invite-and-manage-users.mdx b/docs/guides/invite-and-manage-users.mdx index 8314054811a..5dc3de366f4 100644 --- a/docs/guides/invite-and-manage-users.mdx +++ b/docs/guides/invite-and-manage-users.mdx @@ -18,7 +18,7 @@ If a user has a previously existing IBM Cloud account, follow the instructions i 1. First, ensure you have the correct account and region selected in the account and region switchers in the header. -1. Select [*Access management*](https://quantum.cloud.ibm.com/users) from the main menu. +1. Select [*Access management*](/users) from the main menu. 1. On the Users tab, click "Invite user". 1. Enter the users' email addresses and optionally assign the invited users to access groups. 1. The user will receive an invitation to create an IBM Cloud account and join the instance. After they accept the invitation, they will see a new account in their account switcher at the top of the IBM Quantum Platform page. @@ -26,11 +26,11 @@ If a user has a previously existing IBM Cloud account, follow the instructions i ## Manage a user's access groups -To change a user's access groups, go to [*Access management*](https://quantum.cloud.ibm.com/users) from the main menu. Click the overflow menu at the end of the user's row and select *Manage access*. On the modal that opens, select the access groups the user should belong to. +To change a user's access groups, go to [*Access management*](/users) from the main menu. Click the overflow menu at the end of the user's row and select *Manage access*. On the modal that opens, select the access groups the user should belong to. ## Remove a user -To remove a user from an instance, go to [*Access management*](https://quantum.cloud.ibm.com/users) from the main menu. Click the overflow menu at the end of the user's row, and select *Delete*. You are prompted to confirm the deletion. +To remove a user from an instance, go to [*Access management*](/users) from the main menu. Click the overflow menu at the end of the user's row, and select *Delete*. You are prompted to confirm the deletion. If a user is removed from an instance, their workloads and the associated results are no longer visible to them. Other users in the same instance can still access the workload data and results. diff --git a/docs/guides/kipu-optimization.ipynb b/docs/guides/kipu-optimization.ipynb index 123592c7709..03a175f5e24 100644 --- a/docs/guides/kipu-optimization.ipynb +++ b/docs/guides/kipu-optimization.ipynb @@ -252,7 +252,7 @@ "source": [ "## Get started\n", "\n", - "Authenticate using your API key, found on the [IBM Quantum Platform dashboard](http://quantum.cloud.ibm.com/), and select the Qiskit Function as follows:" + "Authenticate using your API key, found on the [IBM Quantum Platform dashboard](/), and select the Qiskit Function as follows:" ] }, { diff --git a/docs/guides/latest-updates.mdx b/docs/guides/latest-updates.mdx index e20b4ecceb4..c8beca43a6d 100644 --- a/docs/guides/latest-updates.mdx +++ b/docs/guides/latest-updates.mdx @@ -24,15 +24,15 @@ Jump to [IBM Quantum Platform](#latest-platform) | [Qiskit SDK](#latest-qiskit-s ## IBM Quantum Platform -This section summarizes the recent enhancements and new features for the new [IBM Quantum Platform.](https://quantum.cloud.ibm.com/) +This section summarizes the recent enhancements and new features for the new [IBM Quantum Platform.](/) **24 June 2025** -- Profile page: Now you can find integrated profile details directly in the new platform. Find your profile by clicking on the user icon in the top right or visiting your [profile page.](https://quantum.cloud.ibm.com/profile) -- Public backends: View a list of US backends without logging in, available on the updated [Compute Resources](https://quantum.cloud.ibm.com/computers) page. +- Profile page: Now you can find integrated profile details directly in the new platform. Find your profile by clicking on the user icon in the top right or visiting your [profile page.](/profile) +- Public backends: View a list of US backends without logging in, available on the updated [Compute Resources](/computers) page. - Learning: Quantum computing courses have now been released in the upgraded platform, along with new educational modules designed to help teachers bring Qiskit into their classrooms. This is the first step towards migrating IBM Quantum Learning to the new platform, with more resources to be released in the coming weeks. Resources can be accessed without needing to log in at [IBM Quantum Learning.](/learning) Check out new and updated content, including [Quantum diagonalization algorithms](/learning/courses/quantum-diagonalization-algorithms), [Quantum computing in practice](/learning/courses/quantum-computing-in-practice), and Qiskit in Classrooms modules like [Quantum mechanics](/learning/modules/quantum-mechanics) and [Computer science](/learning/modules/computer-science). -- IBM Quantum Composer: The circuit-building [Composer](https://quantum.cloud.ibm.com/composer) has now been migrated to the new platform. The experience is largely the same, except for files will no longer be stored in the platform, and will need to be downloaded locally. Find more details in the [Composer documentation](/docs/guides/composer). -- Announcements: Now you can access news, software updates, and service alerts on the new platform. Click the bell icon in the top navigation bar or the link under Featured resources on the [home page](https://quantum.cloud.ibm.com/) to visit the new [Announcements](/announcements) page. +- IBM Quantum Composer: The circuit-building [Composer](/composer) has now been migrated to the new platform. The experience is largely the same, except for files will no longer be stored in the platform, and will need to be downloaded locally. Find more details in the [Composer documentation](/docs/guides/composer). +- Announcements: Now you can access news, software updates, and service alerts on the new platform. Click the bell icon in the top navigation bar or the link under Featured resources on the [home page](/) to visit the new [Announcements](/announcements) page.
Previous updates @@ -53,16 +53,16 @@ This section summarizes the recent enhancements and new features for the new [IB - [Flex Plan](https://www.ibm.com/quantum/blog/flex-plan), a new resource consumption offering, has been released. - [Tutorials](/docs/tutorials) are now available on the platform to help users with use-case exploration. -- The [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions) has launched on the platform. +- The [Qiskit Functions Catalog](/functions) has launched on the platform. - Updated Session OpenAPI schema: `backend_name` field is now nullable. **24 April 2025** -- Instance limits: Individuals can view [available time and usage,](https://quantum.cloud.ibm.com/instances) which displays alerts when approaching limits. +- Instance limits: Individuals can view [available time and usage,](/instances) which displays alerts when approaching limits. - Administrator permissions: Administrators can view overall usage, cycle period, and remaining time per plan in the Instances page. - Search: Search is now integrated and available for filtering documentation content, including guides and API references. -- Billing: Pay-As-You-Go users can find a link to billing by clicking the overflow menu for each instance on the [Instances](https://quantum.cloud.ibm.com/instances) page. -- New sign-in option: Sign-in with Google is now available on the [sign-in page.](https://quantum.cloud.ibm.com/signin) +- Billing: Pay-As-You-Go users can find a link to billing by clicking the overflow menu for each instance on the [Instances](/instances) page. +- New sign-in option: Sign-in with Google is now available on the [sign-in page.](/signin) - Bug fixes: - Addressed failed batch sessions for Open Plan users. - Addressed batch sessions not closing properly. @@ -98,9 +98,9 @@ For full details on the early access release and upcoming improvements, [check o **26 February 2025** -- Today, we are releasing an early access version of the upgraded experience, and invite you to [open an account and explore the new interface](https://quantum.cloud.ibm.com). We will continue to roll out updates over the coming months, with the end goal of creating an experience that looks and feels like the classic version of IBM Quantum Platform, but with greater functionality. We will eventually sunset IBM Quantum Platform classic, so stay tuned for updates. +- Today, we are releasing an early access version of the upgraded experience, and invite you to [open an account and explore the new interface](/). We will continue to roll out updates over the coming months, with the end goal of creating an experience that looks and feels like the classic version of IBM Quantum Platform, but with greater functionality. We will eventually sunset IBM Quantum Platform classic, so stay tuned for updates. -- Please note: If your IBM Quantum Platform access falls under a plan administrator (Premium Plan, On-Prem Plan, Startup Program, etc.), you will receive guided migration support through your administrator in the coming months. In the meantime, you are welcome to [create a free Open Plan account to explore the new platform.](https://quantum.cloud.ibm.com) +- Please note: If your IBM Quantum Platform access falls under a plan administrator (Premium Plan, On-Prem Plan, Startup Program, etc.), you will receive guided migration support through your administrator in the coming months. In the meantime, you are welcome to [create a free Open Plan account to explore the new platform.](/) - For full details on the early access release and upcoming improvements, [check out the blog](https://www.ibm.com/quantum/blog/iqp-upgrade).
@@ -311,11 +311,11 @@ Improvements include the following: **5 June 2025** - We're excited to roll out two new functions for finance and optimization: - - [QUICK-PDE](https://quantum.cloud.ibm.com/functions?id=colibritd-quick-pde) by ColibriTD allows users to solve certain differential equations for material deformation and computational fluid dynamics problems. For example, one team of researchers has already begun using the QUICK-PDE function to study the dynamics of novel reactive fluids developed to transfer heat more efficiently in a type of nuclear reactor known as Small Modular Reactors. + - [QUICK-PDE](/functions?id=colibritd-quick-pde) by ColibriTD allows users to solve certain differential equations for material deformation and computational fluid dynamics problems. For example, one team of researchers has already begun using the QUICK-PDE function to study the dynamics of novel reactive fluids developed to transfer heat more efficiently in a type of nuclear reactor known as Small Modular Reactors. - - [Quantum Portfolio Optimizer](https://quantum.cloud.ibm.com/functions?id=global-data-quantum-quantum-portfolio-optimizer) by Global Data Quantum enables quantitative finance researchers to back-test portfolio optimization strategies. Running on over 100 qubits, this function calculates a portfolio’s Sharpe ratio versus return across a specified time period. Early users are exploring the optimizer’s ability to evaluate historical performance of an investment strategy and to enable comparisons of different portfolios under similar conditions. + - [Quantum Portfolio Optimizer](/functions?id=global-data-quantum-quantum-portfolio-optimizer) by Global Data Quantum enables quantitative finance researchers to back-test portfolio optimization strategies. Running on over 100 qubits, this function calculates a portfolio’s Sharpe ratio versus return across a specified time period. Early users are exploring the optimizer’s ability to evaluate historical performance of an investment strategy and to enable comparisons of different portfolios under similar conditions. -Check out the [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions) to request a free trial today. +Check out the [Qiskit Functions Catalog](/functions) to request a free trial today. **4 June 2025** @@ -380,7 +380,7 @@ Check out the [Qiskit Functions Catalog](https://quantum.cloud.ibm.com/functions - We're hoping these changes make it easier to use Qiskit Functions, and [you can get started with free trials in the catalog today.](https://quantum.cloud.ibm.com/functions) + We're hoping these changes make it easier to use Qiskit Functions, and [you can get started with free trials in the catalog today.](/functions) **10 March 2025** diff --git a/docs/guides/manage-cost.mdx b/docs/guides/manage-cost.mdx index 4a6beca0a0d..2fab6a1fe37 100644 --- a/docs/guides/manage-cost.mdx +++ b/docs/guides/manage-cost.mdx @@ -19,7 +19,7 @@ The _cost limit_ refers to the total cost of all workloads run with this instanc There are several ways to set or change a limit on how much is spent: -* **IBM Quantum Platform**: Open the [Instances](https://quantum.cloud.ibm.com/instances) table. Find the instance you want to limit, click the overflow menu at the end of the row, and then click **Edit details**. Set the total cost limit or the usage limit, then click **Save changes**. +* **IBM Quantum Platform**: Open the [Instances](/instances) table. Find the instance you want to limit, click the overflow menu at the end of the row, and then click **Edit details**. Set the total cost limit or the usage limit, then click **Save changes**. You can also set the cost or usage limit when creating a new instance under the Pay-As-You-Go Plan. When you select the Pay-As-You-Go tile, a field appears with the label "Total cost limit (Optional)". You can enter a total cost limit in this field. @@ -41,7 +41,7 @@ There are several ways to set or change a limit on how much is spent: There are several ways to view the current cost limit: -* **IBM Quantum Platform**: The Max cost limit is shown on the Pay-As-You-Go tab of the [Instances](https://quantum.cloud.ibm.com/instances) table. +* **IBM Quantum Platform**: The Max cost limit is shown on the Pay-As-You-Go tab of the [Instances](/instances) table. * **API**: @@ -61,7 +61,7 @@ There are several ways to view the current cost limit: You can remove the cost limit in several ways: -* **IBM Quantum Platform**: Open the [Instances](https://quantum.cloud.ibm.com/instances) table. Find the instance you want to update, click the overflow menu at the end of the row, and then click **Edit details**. Delete the total cost limit or the usage, then click **Save changes**. +* **IBM Quantum Platform**: Open the [Instances](/instances) table. Find the instance you want to update, click the overflow menu at the end of the row, and then click **Edit details**. Delete the total cost limit or the usage, then click **Save changes**. * **API**: [Set the instance limit to `null`.](/docs/api/qiskit-runtime-rest/tags/instances) @@ -90,11 +90,11 @@ Additionally, you can determine cost per instance or per job at any time. ### View usage -View the instance's usage on the [Analytics](https://quantum.cloud.ibm.com/analytics) page. +View the instance's usage on the [Analytics](/analytics) page. ### View instance cost -To determine how much has been billed to an instance during the current billing cycle, from the [Instances](https://quantum.cloud.ibm.com/instances) page, click the instance to open its details page. +To determine how much has been billed to an instance during the current billing cycle, from the [Instances](/instances) page, click the instance to open its details page. These are the fields relevant to cost: @@ -107,7 +107,7 @@ You can view your billing cycle on the [Billing and usage page](https://cloud.ib ### View job cost -To determine how much has been billed to each job associated with an instance, from the [Instances](https://quantum.cloud.ibm.com/instances) page, click the instance to open its details page. Next, on the left side, click Jobs. +To determine how much has been billed to each job associated with an instance, from the [Instances](/instances) page, click the instance to open its details page. Next, on the left side, click Jobs. These are the columns relevant to cost: diff --git a/docs/guides/max-execution-time.ipynb b/docs/guides/max-execution-time.ipynb index 21c748526a4..1c6c989b26c 100644 --- a/docs/guides/max-execution-time.ipynb +++ b/docs/guides/max-execution-time.ipynb @@ -90,7 +90,7 @@ "\n", "\n", "* Inputs to jobs cannot exceed 50MB in size.\n", - "* Open Plan users can use up to 10 minutes of quantum time per 28-day rolling window. Quantum time is the amount of time that the QPU is dedicated to processing your job. You can view an instance's usage on the [Instances](https://quantum.cloud.ibm.com/instances) page.\n", + "* Open Plan users can use up to 10 minutes of quantum time per 28-day rolling window. Quantum time is the amount of time that the QPU is dedicated to processing your job. You can view an instance's usage on the [Instances](/instances) page.\n", "\n", "## Next steps\n", "\n", diff --git a/docs/guides/monitor-job.ipynb b/docs/guides/monitor-job.ipynb index 0570de5cfd9..9f9f53b1811 100644 --- a/docs/guides/monitor-job.ipynb +++ b/docs/guides/monitor-job.ipynb @@ -7,19 +7,19 @@ "source": [ "# Monitor or cancel a job\n", "\n", - "View a list of your workloads on the [Workloads page](https://quantum.cloud.ibm.com/workloads).\n", + "View a list of your workloads on the [Workloads page](/workloads).\n", "\n", "## View job status\n", "\n", - "Go to your [Workloads table](https://quantum.cloud.ibm.com/workloads) and check under the Status column for whether a job has completed or failed.\n", + "Go to your [Workloads table](/workloads) and check under the Status column for whether a job has completed or failed.\n", "\n", "## View remaining usage\n", "\n", - "Go to your [Instances table](https://quantum.cloud.ibm.com/instances) and select the tab associated with the plan you want to view remaining usage for. Total time used and total time remaining on your plan is displayed.\n", + "Go to your [Instances table](/instances) and select the tab associated with the plan you want to view remaining usage for. Total time used and total time remaining on your plan is displayed.\n", "\n", "## View metrics on number of jobs and workloads submitted\n", "\n", - "Go to the [Analytics page](https://quantum.cloud.ibm.com/analytics) to see the total number of jobs submitted, as well as a count of batch workloads and session workloads. Note that you can only see the Analytics page for accounts that you own or manage.\n", + "Go to the [Analytics page](/analytics) to see the total number of jobs submitted, as well as a count of batch workloads and session workloads. Note that you can only see the Analytics page for accounts that you own or manage.\n", "\n", "## Monitor a job\n", "\n", diff --git a/docs/guides/multiverse-computing-singularity.ipynb b/docs/guides/multiverse-computing-singularity.ipynb index 3f830ecf616..c43675f54a7 100644 --- a/docs/guides/multiverse-computing-singularity.ipynb +++ b/docs/guides/multiverse-computing-singularity.ipynb @@ -637,7 +637,7 @@ "source": [ "## Get started\n", "\n", - "Authenticate using your [IBM Quantum Platform API key](http://quantum.cloud.ibm.com/), and select the Qiskit Function as follows:" + "Authenticate using your [IBM Quantum Platform API key](/), and select the Qiskit Function as follows:" ] }, { @@ -1095,7 +1095,7 @@ "\n", "\n", "\n", - "- Request access to [Multiverse Computing's Singularity Machine Learning Classification function](https://quantum.cloud.ibm.com/functions?id=multiverse-singularity).\n", + "- Request access to [Multiverse Computing's Singularity Machine Learning Classification function](/functions?id=multiverse-singularity).\n", "\n", "" ] diff --git a/docs/guides/plans-overview.mdx b/docs/guides/plans-overview.mdx index 9dcf4951638..ea92f8af608 100644 --- a/docs/guides/plans-overview.mdx +++ b/docs/guides/plans-overview.mdx @@ -27,7 +27,7 @@ If you want access to multiple plans, you can create multiple instances and assi ## Open Plan -Run your quantum circuits on the world's best QPUs for free (up to 10 minutes quantum time per 28-day rolling window). You can track your usage on the [Platform dashboard](https://quantum.cloud.ibm.com/) and the [Workloads](https://quantum.cloud.ibm.com/workloads) pages. The Open Plan is only available in the us-east region. +Run your quantum circuits on the world's best QPUs for free (up to 10 minutes quantum time per 28-day rolling window). You can track your usage on the [Platform dashboard](/) and the [Workloads](/workloads) pages. The Open Plan is only available in the us-east region. This plan is recommended for those who are learning quantum computing and exploring IBM quantum technology. @@ -35,7 +35,7 @@ This plan is recommended for those who are learning quantum computing and explor Pre-purchase a certain number of minutes (at least 400) for running quantum jobs, to be used within one year of purchase. You can purchase more minutes at any time. -After purchasing time, you must allocate the minutes to existing or new instances on the Flex Plan for your account. Set or update allocation limits on the [Instances page](https://quantum.cloud.ibm.com/instances) or set the allocation when you [create a new Flex Plan instance.](/docs/guides/instances) If you allocate all of the minutes to existing instances, you can't create a new instance for the Flex Plan until you purchase more minutes or remove some minutes from another instance's allocation. See [Set instance allocation limits](allocation-limits) to learn more. +After purchasing time, you must allocate the minutes to existing or new instances on the Flex Plan for your account. Set or update allocation limits on the [Instances page](/instances) or set the allocation when you [create a new Flex Plan instance.](/docs/guides/instances) If you allocate all of the minutes to existing instances, you can't create a new instance for the Flex Plan until you purchase more minutes or remove some minutes from another instance's allocation. See [Set instance allocation limits](allocation-limits) to learn more. If you need more than 10,000 minutes, you should consider a Premium Plan subscription instead. If you don't want to purchase 400 minutes, consider the Pay-As-You-Go Plan instead. diff --git a/docs/guides/processor-types.mdx b/docs/guides/processor-types.mdx index f4c5381a664..4ac25e6ea49 100644 --- a/docs/guides/processor-types.mdx +++ b/docs/guides/processor-types.mdx @@ -18,7 +18,7 @@ To find the native gates and operations of a backend, use [this code](/docs/guid At 156 qubits, Heron is an [Eagle](#eagle)-sized upgrade to Egret that pulls in substantial innovations in signal delivery that were previously deployed in Osprey. The signals required to enable the fast, high-fidelity two-qubit and single-qubit control are delivered with high-density flex cabling. -* [View available Heron processors](https://quantum.cloud.ibm.com/computers?processorType=Heron) +* [View available Heron processors](/computers?processorType=Heron) `r3` (July 2025) Heron r3 is the result of targeted manufacturing improvements that directly impact coherence, gate fidelity, and readout performance. @@ -37,7 +37,7 @@ At 127 qubits, the Eagle processor family incorporates more scalable packaging t See [IBM Quantum breaks the 100‑qubit processor barrier](https://www.ibm.com/quantum/blog/127-qubit-quantum-processor-eagle) for more about the Eagle processor family. -* [View available Eagle processors](https://quantum.cloud.ibm.com/computers?processorType=Eagle) +* [View available Eagle processors](/computers?processorType=Eagle) `r3` (December 2022) Eagle r3 is a version of the 127-qubit processor with enhanced coherence properties but otherwise similar design parameters to Eagle r1. diff --git a/docs/guides/pulse.ipynb b/docs/guides/pulse.ipynb index c4233565fe1..3f159b4fbdb 100644 --- a/docs/guides/pulse.ipynb +++ b/docs/guides/pulse.ipynb @@ -63,7 +63,7 @@ "\n", "This page shows you how to add a calibration to your circuit.\n", "\n", - "**Note:** Not all QPUs support pulse gates. To see which QPUs have pulse gate support, filter your view (click the funnel icon) on the [Compute resources page](https://quantum.cloud.ibm.com/computers) by checking the _Pulse gates_ box." + "**Note:** Not all QPUs support pulse gates. To see which QPUs have pulse gate support, filter your view (click the funnel icon) on the [Compute resources page](/computers) by checking the _Pulse gates_ box." ] }, { diff --git a/docs/guides/q-ctrl-optimization-solver.ipynb b/docs/guides/q-ctrl-optimization-solver.ipynb index 21df348645f..1a727d35e07 100644 --- a/docs/guides/q-ctrl-optimization-solver.ipynb +++ b/docs/guides/q-ctrl-optimization-solver.ipynb @@ -139,7 +139,7 @@ "source": [ "## Get started\n", "\n", - "First, authenticate using your [IBM Quantum API key](http://quantum.cloud.ibm.com/). Then, select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" + "First, authenticate using your [IBM Quantum API key](/). Then, select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" ] }, { @@ -574,7 +574,7 @@ "\n", "\n", "\n", - "- Request access to [Q-CTRL Optimization Solver.](https://quantum.cloud.ibm.com/functions?id=q-ctrl-optimization-solver)\n", + "- Request access to [Q-CTRL Optimization Solver.](/functions?id=q-ctrl-optimization-solver)\n", "- Try the [Solve higher-order binary optimization problems with Q-CTRL's Optimization Solver](/docs/tutorials/solve-higher-order-binary-optimization-problems-with-q-ctrls-optimization-solver) tutorial.\n", "\n", "" diff --git a/docs/guides/q-ctrl-performance-management.ipynb b/docs/guides/q-ctrl-performance-management.ipynb index 934ab351d75..681a8ebea8a 100644 --- a/docs/guides/q-ctrl-performance-management.ipynb +++ b/docs/guides/q-ctrl-performance-management.ipynb @@ -106,7 +106,7 @@ "## Get started\n", "\n", "Fire Opal Performance Management uses Qiskit v`2.0.0`, which is the recommended version. Supported versions are Qiskit >=v`2.0.0`.\n", - "Authenticate using your [IBM Quantum Platform API key](http://quantum.cloud.ibm.com/), and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" + "Authenticate using your [IBM Quantum Platform API key](/), and select the Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" ] }, { @@ -693,7 +693,7 @@ "\n", "\n", "\n", - "- Request access to [Q-CTRL Performance Management](https://quantum.cloud.ibm.com/functions?id=q-ctrl-performance-management)\n", + "- Request access to [Q-CTRL Performance Management](/functions?id=q-ctrl-performance-management)\n", "\n", "" ] diff --git a/docs/guides/qedma-qesem.ipynb b/docs/guides/qedma-qesem.ipynb index 5f5fe1a27e0..ff845069324 100644 --- a/docs/guides/qedma-qesem.ipynb +++ b/docs/guides/qedma-qesem.ipynb @@ -109,7 +109,7 @@ "source": [ "## Get started\n", "\n", - "Authenticate using your [IBM Quantum Platform API key](http://quantum.cloud.ibm.com/), and select the QESEM Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" + "Authenticate using your [IBM Quantum Platform API key](/), and select the QESEM Qiskit Function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)" ] }, { @@ -408,7 +408,7 @@ "\n", "\n", "\n", - "- [Request access to Qedma QESEM](https://quantum.cloud.ibm.com/functions?id=qedma-qesem)\n", + "- [Request access to Qedma QESEM](/functions?id=qedma-qesem)\n", "\n", "" ] diff --git a/docs/guides/qiskit-code-assistant-vscode.mdx b/docs/guides/qiskit-code-assistant-vscode.mdx index 365e6f2adf2..dd4cdb544e9 100644 --- a/docs/guides/qiskit-code-assistant-vscode.mdx +++ b/docs/guides/qiskit-code-assistant-vscode.mdx @@ -8,7 +8,7 @@ description: How to install, use, and configure Qiskit Code Assistant in Visual Learn how to install, use, configure and uninstall the official Qiskit Code Assistant extension in Visual Studio Code (VS Code). - - This is an experimental feature available to IBM Quantum® Premium Plan, Flex Plan, and On-Prem (via IBM Quantum Platform API) Plan users with an account on the new [IBM Quantum Platform.](https://quantum.cloud.ibm.com/) + - This is an experimental feature available to IBM Quantum® Premium Plan, Flex Plan, and On-Prem (via IBM Quantum Platform API) Plan users with an account on the new [IBM Quantum Platform.](/) - Qiskit Code Assistant is in preview release status and is subject to change. - If you have feedback or want to contact the developer team, use the [Qiskit Slack Workspace channel](https://qiskit.enterprise.slack.com/archives/C07LYA6PL83) or the related public GitHub repositories. diff --git a/docs/guides/qiskit-code-assistant.mdx b/docs/guides/qiskit-code-assistant.mdx index 63ca1bd2cd1..f3a9748aaad 100644 --- a/docs/guides/qiskit-code-assistant.mdx +++ b/docs/guides/qiskit-code-assistant.mdx @@ -8,7 +8,7 @@ description: Learn how to use Qiskit Code Assistant, a generative AI code assist Qiskit Code Assistant aims to make quantum computing more accessible to new Qiskit adopters and to improve the coding experience for current users. It is a generative AI code assistant powered by [watsonx](https://www.ibm.com/products/watsonx-ai). It is trained using millions of text tokens from Qiskit SDK v1.x, years of Qiskit code examples and IBM Quantum® features. Qiskit Code Assistant can help your quantum development workflow by offering LLM-generated suggestions based on [IBM Granite models,](https://www.ibm.com/products/watsonx-ai/foundation-models) which incorporate the latest features and functionalities from IBM®. - - This is an experimental feature available to IBM Quantum Premium Plan users registered on the new [IBM Quantum Platform.](https://quantum.cloud.ibm.com/) + - This is an experimental feature available to IBM Quantum Premium Plan users registered on the new [IBM Quantum Platform.](/) - Qiskit Code Assistant is in preview release status and is subject to change. - If you have feedback or want to contact the developer team, use the [Qiskit Slack Workspace channel](https://qiskit.enterprise.slack.com/archives/C07LYA6PL83) or the related public GitHub repositories. diff --git a/docs/guides/qpu-information.mdx b/docs/guides/qpu-information.mdx index b790fee6db8..3abf2f60096 100644 --- a/docs/guides/qpu-information.mdx +++ b/docs/guides/qpu-information.mdx @@ -9,7 +9,7 @@ in_page_toc_max_heading_level: 2 IBM® offers access to a wide variety of quantum processing units (QPUs). All QPUs deployed by IBM are based on superconducting qubit technology, as the control and scalability of this technology pave a clear path to achieving quantum advantage with these QPUs. -Explore all public IBM QPUs by navigating to the [Compute resources](https://quantum.cloud.ibm.com/computers) page on IBM Quantum® Platform. Click any QPU to open its detailed information card. +Explore all public IBM QPUs by navigating to the [Compute resources](/computers) page on IBM Quantum® Platform. Click any QPU to open its detailed information card. This page describes the detailed information you will find on the QPU information card. @@ -189,7 +189,7 @@ The third section provides the expanded view of the lowest `two-qubit gate error ## View your resources -To find your available QPUs, open the [Compute resources](https://quantum.cloud.ibm.com/computers) page (make sure you are signed in). Note that your selected region might impact the QPUs listed. Click a QPU to view its details. +To find your available QPUs, open the [Compute resources](/computers) page (make sure you are signed in). Note that your selected region might impact the QPUs listed. Click a QPU to view its details. You can also view your available QPUs by using the [backends API.](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#backends) For example, the following code will return all of the backends that the specified instance (`my_instance`) can access: diff --git a/docs/guides/qunova-chemistry.ipynb b/docs/guides/qunova-chemistry.ipynb index d6760702e67..63825b96070 100644 --- a/docs/guides/qunova-chemistry.ipynb +++ b/docs/guides/qunova-chemistry.ipynb @@ -109,7 +109,7 @@ "## Get started\n", "\n", "First, [request access to the function](https://forms.office.com/r/zN3hvMTqJ1).\n", - "Then, authenticate using your [IBM Quantum® API key](http://quantum.cloud.ibm.com/) and, assuming you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment, select the Qiskit Function as follows:" + "Then, authenticate using your [IBM Quantum® API key](/) and, assuming you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment, select the Qiskit Function as follows:" ] }, { diff --git a/docs/guides/retired-qpus.ipynb b/docs/guides/retired-qpus.ipynb index bdc59828657..49108586d39 100644 --- a/docs/guides/retired-qpus.ipynb +++ b/docs/guides/retired-qpus.ipynb @@ -17,7 +17,7 @@ "id": "2559dcba-8131-4bed-8286-017a13a312e0", "metadata": {}, "source": [ - "The following IBM® quantum processing units (QPUs) have been retired. For the full list of available QPUs, see the [Compute resources](https://quantum.cloud.ibm.com/computers) page.\n", + "The following IBM® quantum processing units (QPUs) have been retired. For the full list of available QPUs, see the [Compute resources](/computers) page.\n", "\n", "\n", " To retrieve jobs from a retired QPU, see [these instructions.](#retrieve)\n", diff --git a/docs/guides/run-jobs-session.ipynb b/docs/guides/run-jobs-session.ipynb index bb68412a2ca..40a6df73618 100644 --- a/docs/guides/run-jobs-session.ipynb +++ b/docs/guides/run-jobs-session.ipynb @@ -298,7 +298,7 @@ "\n", "## Check session status\n", "\n", - "You can query a session's status to understand its current state by using `session.status()` or by viewing the [Workloads](https://quantum.cloud.ibm.com/workloads) page.\n", + "You can query a session's status to understand its current state by using `session.status()` or by viewing the [Workloads](/workloads) page.\n", "\n", "\n", "Session status can be one of the following:\n", diff --git a/docs/guides/save-credentials.mdx b/docs/guides/save-credentials.mdx index ed9a2551751..04a8499271a 100644 --- a/docs/guides/save-credentials.mdx +++ b/docs/guides/save-credentials.mdx @@ -14,14 +14,14 @@ If you are working in a trusted Python environment (such as on a personal laptop ## Before you begin -1. Ensure that you have an [IBM Cloud account.](https://quantum.cloud.ibm.com/registration) +1. Ensure that you have an [IBM Cloud account.](/registration) 1. Ensure you are working in an active Python environment with the [Qiskit SDK and Qiskit Runtime installed](/docs/guides/install-qiskit#local). 1. Activate the Python virtual environment and run Python in your virtual environment. 1. Find your access credentials. - 1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com) with an IBMid or Google account. + 1. Log in to [IBM Quantum Platform](/) with an IBMid or Google account. 1. Make sure that the correct account and region are selected in the account switcher in the header. - 1. Find your API key. From the [dashboard](https://quantum.cloud.ibm.com/), create your API key, then copy it to a secure location so you can use it for authentication. Note that you can use the same API key to connect to any region. - 1. Optional: Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. + 1. Find your API key. From the [dashboard](/), create your API key, then copy it to a secure location so you can use it for authentication. Note that you can use the same API key to connect to any region. + 1. Optional: Find the instance you want to use from the [Instances](/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance. ## Save your access credentials diff --git a/docs/guides/save-jobs.ipynb b/docs/guides/save-jobs.ipynb index 7ce4c7fc4b3..b171f2319dd 100644 --- a/docs/guides/save-jobs.ipynb +++ b/docs/guides/save-jobs.ipynb @@ -44,7 +44,7 @@ "source": [ "## Retrieve job results from IBM Quantum\n", "\n", - "IBM Quantum automatically stores results from every job for you to retrieve at a later date. Use this feature to continue quantum programs across kernel restarts and review past results. You can get the ID of a job programmatically through its `job_id` method, or you can see all your submitted jobs and their IDs on the [Workloads page](https://quantum.cloud.ibm.com/workloads).\n", + "IBM Quantum automatically stores results from every job for you to retrieve at a later date. Use this feature to continue quantum programs across kernel restarts and review past results. You can get the ID of a job programmatically through its `job_id` method, or you can see all your submitted jobs and their IDs on the [Workloads page](/workloads).\n", "\n", "To find a job programmatically, use the [`QiskitRuntimeService.jobs`](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#jobs) method. By default, this returns the most recently submitted jobs, but you can also filter jobs by backend name, creation date, and more. The following cell finds any jobs submitted in the last three months. The `created_after` argument must be a [`datetime.datetime`](https://docs.python.org/3.8/library/datetime.html#datetime.datetime) object." ] diff --git a/docs/guides/serverless-first-program.ipynb b/docs/guides/serverless-first-program.ipynb index 9f17bfbc8ce..7d78892edca 100644 --- a/docs/guides/serverless-first-program.ipynb +++ b/docs/guides/serverless-first-program.ipynb @@ -241,7 +241,7 @@ "\n", "The previous section created a program to be run remotely. The code cells in this section upload that program to Qiskit Serverless.\n", "\n", - "Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key, which you can find on the [IBM Quantum dashboard](https://quantum.cloud.ibm.com), and upload the program.\n", + "Use `qiskit-ibm-catalog` to authenticate to `QiskitServerless` with your API key, which you can find on the [IBM Quantum dashboard](/), and upload the program.\n", "\n", "You can use `save_account()` to save your credentials (See the [Set up to use IBM Cloud](/docs/guides/cloud-setup#cloud-save) section). Note that this writes your credentials to the same file as [`QiskitRuntimeService.save_account()`](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#save_account)." ] diff --git a/docs/guides/serverless-run-first-workload.ipynb b/docs/guides/serverless-run-first-workload.ipynb index bd2f9f6b6b3..13e02f36bb4 100644 --- a/docs/guides/serverless-run-first-workload.ipynb +++ b/docs/guides/serverless-run-first-workload.ipynb @@ -38,7 +38,7 @@ "source": [ "This section explores how to use `qiskit-ibm-catalog` to list programs available in Qiskit Serverless, pass inputs into these programs, run them remotely, check their status, and retrieve results and logs.\n", "\n", - "Be sure you have authenticated to Qiskit Serverless using your [API key](https://quantum.cloud.ibm.com/) (see [Deploy to IBM Quantum Platform](./serverless-first-program#deploy-to-ibm-quantum-platform) for instructions)." + "Be sure you have authenticated to Qiskit Serverless using your [API key](/) (see [Deploy to IBM Quantum Platform](./serverless-first-program#deploy-to-ibm-quantum-platform) for instructions)." ] }, { diff --git a/docs/guides/view-cost.mdx b/docs/guides/view-cost.mdx index 61ec1ebf730..457e71269e0 100644 --- a/docs/guides/view-cost.mdx +++ b/docs/guides/view-cost.mdx @@ -11,7 +11,7 @@ At any time, you can see how much cost has been incurred by jobs associated with ## View instance cost -To determine how much has been billed to an instance during the current billing cycle, from the [Instances page](https://quantum.cloud.ibm.com/instances), click the instance to open its details page. +To determine how much has been billed to an instance during the current billing cycle, from the [Instances page](/instances), click the instance to open its details page. These fields are relevant to cost: @@ -24,7 +24,7 @@ You can view your billing cycle on the [IBM Cloud Billing and usage page.](https ## View job cost -To determine how much has been billed to each job associated with an instance, from the [Instances page](https://quantum.cloud.ibm.com/instances), click the instance to open its details page. Next, on the left side, click Jobs. +To determine how much has been billed to each job associated with an instance, from the [Instances page](/instances), click the instance to open its details page. Next, on the left side, click Jobs. These are the columns relevant to cost: diff --git a/docs/migration-guides/classic-iqp-to-cloud-iqp.mdx b/docs/migration-guides/classic-iqp-to-cloud-iqp.mdx index 02aeba77730..8348ffc35cf 100644 --- a/docs/migration-guides/classic-iqp-to-cloud-iqp.mdx +++ b/docs/migration-guides/classic-iqp-to-cloud-iqp.mdx @@ -5,7 +5,7 @@ description: Migrate to using the upgraded IBM Quantum Platform for Open users # Migrate to the upgraded IBM Quantum Platform -This guide describes how, why, and when to transition to the [new version of IBM Quantum Platform.](https://quantum.cloud.ibm.com/) +This guide describes how, why, and when to transition to the [new version of IBM Quantum Platform.](/) If you have been invited by your organization to join an account: @@ -62,7 +62,7 @@ The Lite Plan is deprecated and will be removed on 14 March 2025. ## Current IBM Quantum Platform users -Instead of accessing IBM Quantum Platform Classic, you will now access the [upgraded version of IBM Quantum Platform](https://quantum.cloud.ibm.com/), which is integrated with IBM Cloud. To use the new platform, users will need to follow these onboarding instructions. +Instead of accessing IBM Quantum Platform Classic, you will now access the [upgraded version of IBM Quantum Platform](/), which is integrated with IBM Cloud. To use the new platform, users will need to follow these onboarding instructions. ### Save results from IBM Quantum Platform Classic @@ -78,12 +78,12 @@ Jobs that were run on IBM Quantum Platform Classic will not be available after t Follow these steps to set up the new version of IBM Quantum Platform. -1. If you don't already have one, [register for an IBM Cloud account.](https://quantum.cloud.ibm.com/registration) If you already have an IBM Quantum Platform Classic account, use the same email for this account. +1. If you don't already have one, [register for an IBM Cloud account.](/registration) If you already have an IBM Quantum Platform Classic account, use the same email for this account. 2. Create an instance. - 1. Log on to the new [IBM Quantum Platform.](https://quantum.cloud.ibm.com) Choose **IBMid** and enter your IBM Cloud account information. The dashboard opens. + 1. Log on to the new [IBM Quantum Platform.](/) Choose **IBMid** and enter your IBM Cloud account information. The dashboard opens. 1. If you do not already have an instance, Click **Create instance** on the dashboard page. - If you have already created an instance, go to your [Instances page](https://quantum.cloud.ibm.com/instances) to create new ones. + If you have already created an instance, go to your [Instances page](/instances) to create new ones. 1. Specify a name and choose the type of plan you want. Scroll down to see the **Terms** link. After reading the terms, select the **agree** checkbox and click **Next**. 1. On the Plan inheritance page, leave the default setting (toggle is not enabled) and click **Next** if you're setting up an Open instance. If you are not setting up an Open instance and you want a fixed set of QPUs to be available to this plan, enable the "Customize allocated compute resources" toggle, choose the QPUs you want this instance to be able to access, then click **Next**. @@ -94,7 +94,7 @@ Follow these steps to set up the new version of IBM Quantum Platform. -3. Create an API key from the [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com/) and set up your credentials. +3. Create an API key from the [IBM Quantum Platform dashboard](/) and set up your credentials. This API key is only visible for a short amount of time so be sure to store it in a safe place. It can be used to authenticate to either region. To manage your API key, use IBM Cloud. See [Managing user API keys](https://cloud.ibm.com/docs/account?topic=account-userapikey) for instructions. @@ -102,13 +102,13 @@ Follow these steps to set up the new version of IBM Quantum Platform. ### Access Once the onboarding steps are complete, you can now use your API key (`token` parameter) and, optionally, instance CRN (`instance` parameter) to instantiate a `QiskitRuntimeService` in your Python virtual environment. See the [installation instructions](/docs/guides/install-qiskit#local) if you do not already have a virtual environment set up. -To copy the instance CRN, go to your [dashboard,](https://quantum.cloud.ibm.com/) go to [Instances,](https://quantum.cloud.ibm.com/instances) and click the copy icon at the end of the instance's row. The instance name listed in the first column can also be used. If an instance is not specified, all instances in your account will be available. +To copy the instance CRN, go to your [dashboard,](/) go to [Instances,](/instances) and click the copy icon at the end of the instance's row. The instance name listed in the first column can also be used. If an instance is not specified, all instances in your account will be available. Setup details: * The new channel name is `ibm_quantum_platform`. If you previously set your default channel to `ibm_quantum` in your saved credentials, you need to update that setting. If you were previously working with Qiskit Runtime on IBM Cloud, you can skip this. - * It is not required to pass in an instance when saving an account or initializing the `QiskitRuntimeService()`. If an instance is not passed in, all instances will be checked when a backend is retrieved (`service.backend("backend_name")`). If an instance is passed into `save_account()`, or passed in during initialization, it is used as the default instance when retrieving backends. An instance passed in at initialization takes precedence over the one saved in the account. To copy the instance CRN, go to [Instances](https://quantum.cloud.ibm.com/instances) and click the copy icon at the end of the instance's row. + * It is not required to pass in an instance when saving an account or initializing the `QiskitRuntimeService()`. If an instance is not passed in, all instances will be checked when a backend is retrieved (`service.backend("backend_name")`). If an instance is passed into `save_account()`, or passed in during initialization, it is used as the default instance when retrieving backends. An instance passed in at initialization takes precedence over the one saved in the account. To copy the instance CRN, go to [Instances](/instances) and click the copy icon at the end of the instance's row. * New parameters, `region`, and `plans_preference`, have been added to the `QiskitRuntimeService()` initializer and the `save_account()` method. These can be used to prioritize certain instances on the new platform (`ibm_quantum_platform`, and temporarily, `ibm_cloud` channels) without explicitly providing the CRN. @@ -180,7 +180,7 @@ These updates are designed to enhance your workflow while keeping your IBM Cloud #### New interface -Until now, you’ve been using the IBM Cloud interface to create and manage your IBM Quantum instances. With the launch of the new IBM Quantum Platform, you can still view existing instances in [IBM Cloud](https://cloud.ibm.com/resources), but managing them in [IBM Quantum Platform](https://quantum.cloud.ibm.com/) gives you deeper insights and control. +Until now, you’ve been using the IBM Cloud interface to create and manage your IBM Quantum instances. With the launch of the new IBM Quantum Platform, you can still view existing instances in [IBM Cloud](https://cloud.ibm.com/resources), but managing them in [IBM Quantum Platform](/) gives you deeper insights and control. The new IBM Quantum Platform offers a quantum-first experience: @@ -192,8 +192,8 @@ This transition enhances security, scalability, and user experience while keepin ### Steps to migrate -* If you currently use the Pay-As-You-Go Plan, you don't have to do anything. You'll just use the new [IBM Quantum Platform](https://quantum.cloud.ibm.com/) interface. -* If you currently use the Lite Plan (deprecated), you can switch to [using simulators locally](https://quantum.cloud.ibm.com/docs/migration-guides/local-simulators). Optionally, you can [create instances in the Open Plan,](#onboard) which lets you run jobs on quantum hardware. +* If you currently use the Pay-As-You-Go Plan, you don't have to do anything. You'll just use the new [IBM Quantum Platform](/) interface. +* If you currently use the Lite Plan (deprecated), you can switch to [using simulators locally](/docs/migration-guides/local-simulators). Optionally, you can [create instances in the Open Plan,](#onboard) which lets you run jobs on quantum hardware. To set, change, or remove cost limits, you need to use the API or CLI. Follow the instructions in the [Manage cost](/docs/guides/manage-cost#cost-limit) guide. diff --git a/docs/migration-guides/migrate-classic-rest-api.mdx b/docs/migration-guides/migrate-classic-rest-api.mdx index 7158383bb6a..3c206824798 100644 --- a/docs/migration-guides/migrate-classic-rest-api.mdx +++ b/docs/migration-guides/migrate-classic-rest-api.mdx @@ -27,7 +27,7 @@ If you are moving from the [Qiskit Runtime on IBM Cloud REST API](/docs/api/qisk * All existing endpoints are the same, but now have `/v1/` in front. For example, `/jobs` becomes `/v1/jobs`. * There is also one new endpoint: `/v1/versions`. -For the whole schema, see the [Qiskit Runtime API.](https://quantum.cloud.ibm.com/api/docs/) +For the whole schema, see the [Qiskit Runtime API.](/api/docs/) ## Migrate from the Qiskit Runtime REST API on IBM Quantum Platform Classic @@ -81,7 +81,7 @@ curl -X 'GET' \ Many of the endpoints from the REST API on IBM Quantum Platform Classic have either changed or been removed because of this merge. The following sections list the endpoints that are changing, and provide a suggested replacement (if applicable). -For the whole schema, see the [Qiskit Runtime API.](https://quantum.cloud.ibm.com/api/docs/) +For the whole schema, see the [Qiskit Runtime API.](/api/docs/) #### Changes to account- and instance-related endpoints diff --git a/docs/security/responsibilities.mdx b/docs/security/responsibilities.mdx index 8734b434995..21dd05c0709 100644 --- a/docs/security/responsibilities.mdx +++ b/docs/security/responsibilities.mdx @@ -25,7 +25,7 @@ Change management includes tasks such as deployment, configuration, upgrades, pa | --- | --- | --- | | Major version upgrades | Provide availability and tools for major version updates. | Migrate to a supported version before end-of-support for an old version. | | API version changes | Versioning the REST APIs. | Integrate with the wanted version of REST APIs. | -| Updates, fixes, and new features |
  • Provide regular updates, bug fixes, and new features, transparently following a continuous delivery model.
  • Post notifications for changes that impact customers.
|
  • Set preferences to [receive email notifications](https://cloud.ibm.com/user/notifications) and monitor the [IBM Cloud status](https://cloud.ibm.com/status) page for general announcements.
  • Read system-generated notifications and [platform announcements,](https://quantum.cloud.ibm.com/announcements) and take appropriate action.
| +| Updates, fixes, and new features |
  • Provide regular updates, bug fixes, and new features, transparently following a continuous delivery model.
  • Post notifications for changes that impact customers.
|
  • Set preferences to [receive email notifications](https://cloud.ibm.com/user/notifications) and monitor the [IBM Cloud status](https://cloud.ibm.com/status) page for general announcements.
  • Read system-generated notifications and [platform announcements,](/announcements) and take appropriate action.
| ## Identity and access management diff --git a/docs/security/secure-data.mdx b/docs/security/secure-data.mdx index a2d81d167f7..92e333b9134 100644 --- a/docs/security/secure-data.mdx +++ b/docs/security/secure-data.mdx @@ -14,7 +14,7 @@ The data that you store in IBM Cloud® is encrypted at rest by using a random ## Deleting your data -Deleting a service instance removes all of the content associated with that instance, such as your jobs, results, parameters, and programs. To delete an instance, from the [Instances page,](https://quantum.cloud.ibm.com/instances) find the instance you want to remove, click its overflow menu, then click **Delete**. You will be asked to confirm the deletion. +Deleting a service instance removes all of the content associated with that instance, such as your jobs, results, parameters, and programs. To delete an instance, from the [Instances page,](/instances) find the instance you want to remove, click its overflow menu, then click **Delete**. You will be asked to confirm the deletion. If you have a Manager role, you can also delete an individual job and its data. See more about access policies, groups, and roles in the [documentation](/docs/guides/access-groups). diff --git a/docs/support/faq.mdx b/docs/support/faq.mdx index 6f13fc2b533..35d31204eab 100644 --- a/docs/support/faq.mdx +++ b/docs/support/faq.mdx @@ -40,7 +40,7 @@ Example citation for IBM Quantum Composer: ## I don't see something in the user interface, such as my administration tasks. -Try choosing a different account from the account switcher in the header of the [IBM Quantum Platform](https://quantum.cloud.ibm.com) interface. +Try choosing a different account from the account switcher in the header of the [IBM Quantum Platform](/) interface. ## I'm just using the Open Plan, but I had to put in my credit card. Will I be charged? diff --git a/docs/support/index.mdx b/docs/support/index.mdx index a37ea4552b2..464173386d9 100644 --- a/docs/support/index.mdx +++ b/docs/support/index.mdx @@ -30,7 +30,7 @@ If you are getting an error while trying to create an account and your country i 1. You can use [Documentation](/docs) and [Learning](/learning) resources without an account. 2. Create a [SkillsBuild account](https://www.ibm.com/academic/) if you are a university student. -3. [Create a Trial account](https://quantum.cloud.ibm.com/registration) for 30 days of free access (Note that you will likely lose access at the end of the trial). +3. [Create a Trial account](/registration) for 30 days of free access (Note that you will likely lose access at the end of the trial). If you are the **owner** of a Pay-As-You-Go or Subscription account, you need to create an IBM Cloud account and provide billing information for verification. diff --git a/docs/tutorials/colibritd-pde.ipynb b/docs/tutorials/colibritd-pde.ipynb index 23c2230ab1d..81ccc53ea5a 100644 --- a/docs/tutorials/colibritd-pde.ipynb +++ b/docs/tutorials/colibritd-pde.ipynb @@ -84,7 +84,7 @@ "source": [ "## Setup\n", "\n", - "Authenticate using your [API key](http://quantum.cloud.ibm.com/) and select the function as follows:" + "Authenticate using your [API key](/) and select the function as follows:" ] }, { diff --git a/docs/tutorials/compilation-methods-for-hamiltonian-simulation-circuits.ipynb b/docs/tutorials/compilation-methods-for-hamiltonian-simulation-circuits.ipynb index 66d2529e181..e2cd16b5c3b 100644 --- a/docs/tutorials/compilation-methods-for-hamiltonian-simulation-circuits.ipynb +++ b/docs/tutorials/compilation-methods-for-hamiltonian-simulation-circuits.ipynb @@ -1549,9 +1549,9 @@ "\n", "While the AI transpiler generally delivers better results than SABRE, particularly in circuit depth, the takeaway should not simply be \"always use the AI transpiler.\" There are important nuances to consider:\n", "\n", - "- **AI transpiler** is typically reliable and provides depth-optimized circuits, but it comes with trade-offs in runtime, and also has other limitations, including supported coupling maps and synthesis capabilities. These are detailed in the [Qiskit Transpiler Service documentation](https://quantum.cloud.ibm.com/docs/guides/qiskit-transpiler-service).\n", + "- **AI transpiler** is typically reliable and provides depth-optimized circuits, but it comes with trade-offs in runtime, and also has other limitations, including supported coupling maps and synthesis capabilities. These are detailed in the [Qiskit Transpiler Service documentation](/docs/guides/qiskit-transpiler-service).\n", "\n", - "- In some cases, particularly with very large or hardware-specific circuits, the AI transpiler may not be as effective. In these cases, the default SABRE transpiler remains extremely reliable and can be further optimized by adjusting its parameters (see the [SABRE optimization tutorial](https://quantum.cloud.ibm.com/docs/tutorials/transpilation-optimizations-with-sabre)).\n", + "- In some cases, particularly with very large or hardware-specific circuits, the AI transpiler may not be as effective. In these cases, the default SABRE transpiler remains extremely reliable and can be further optimized by adjusting its parameters (see the [SABRE optimization tutorial](/docs/tutorials/transpilation-optimizations-with-sabre)).\n", "\n", "- It's also important to consider circuit structure when choosing a method. For example, `rustiq` is purpose-built for circuits involving `PauliEvolutionGate` and often yields the best performance for Hamiltonian simulation problems.\n", "\n", diff --git a/docs/tutorials/global-data-quantum-optimizer.ipynb b/docs/tutorials/global-data-quantum-optimizer.ipynb index 042bc3a3c77..48aa00ba765 100644 --- a/docs/tutorials/global-data-quantum-optimizer.ipynb +++ b/docs/tutorials/global-data-quantum-optimizer.ipynb @@ -100,7 +100,7 @@ "source": [ "To use the Quantum Portfolio Optimizer, select the function via the Qiskit Functions Catalog. You need an IBM Quantum Premium Plan or Flex Plan account with a license from Global Data Quantum to run this function.\n", "\n", - "First, authenticate with your [API key.](https://quantum.cloud.ibm.com) Then, load the desired function from the Qiskit Functions Catalog. Here, you are accessing the `quantum_portfolio_optimizer` function from the catalog by using the `QiskitFunctionsCatalog` class. This function allows us to use the predefined Quantum Portfolio Optimization solver." + "First, authenticate with your [API key.](/) Then, load the desired function from the Qiskit Functions Catalog. Here, you are accessing the `quantum_portfolio_optimizer` function from the catalog by using the `QiskitFunctionsCatalog` class. This function allows us to use the predefined Quantum Portfolio Optimization solver." ] }, { diff --git a/docs/tutorials/qunova-hivqe.ipynb b/docs/tutorials/qunova-hivqe.ipynb index 72d71ecfdc5..28be5558202 100644 --- a/docs/tutorials/qunova-hivqe.ipynb +++ b/docs/tutorials/qunova-hivqe.ipynb @@ -325,7 +325,7 @@ "id": "cc7c2793", "metadata": {}, "source": [ - "The entire QPU runtime used in the job can be tracked by logging in to [IBM Quantum Platform](https://quantum.cloud.ibm.com/) and viewing submitted jobs with the `qunova-chemistry-hivqe` tag." + "The entire QPU runtime used in the job can be tracked by logging in to [IBM Quantum Platform](/) and viewing submitted jobs with the `qunova-chemistry-hivqe` tag." ] }, { diff --git a/docs/tutorials/solve-higher-order-binary-optimization-problems-with-q-ctrls-optimization-solver.ipynb b/docs/tutorials/solve-higher-order-binary-optimization-problems-with-q-ctrls-optimization-solver.ipynb index d8a05c0f895..ca110ccbcee 100644 --- a/docs/tutorials/solve-higher-order-binary-optimization-problems-with-q-ctrls-optimization-solver.ipynb +++ b/docs/tutorials/solve-higher-order-binary-optimization-problems-with-q-ctrls-optimization-solver.ipynb @@ -53,7 +53,7 @@ "* Qiskit Functions (`pip install qiskit-ibm-catalog`)\n", "* SymPy (`pip install sympy`)\n", "\n", - "You will also need to get access to the Optimization Solver function. [Fill out the form](https://quantum.cloud.ibm.com/functions?id=q-ctrl-optimization-solver) to request access." + "You will also need to get access to the Optimization Solver function. [Fill out the form](/functions?id=q-ctrl-optimization-solver) to request access." ] }, { @@ -92,7 +92,7 @@ "id": "df157bba", "metadata": {}, "source": [ - "Define your [IBM Quantum Platform](https://quantum.cloud.ibm.com/) credentials, which will be used throughout the tutorial to authenticate to Qiskit Runtime and Qiskit Functions." + "Define your [IBM Quantum Platform](/) credentials, which will be used throughout the tutorial to authenticate to Qiskit Runtime and Qiskit Functions." ] }, { diff --git a/learning/courses/quantum-business-foundations/how-to-become-quantum-ready.mdx b/learning/courses/quantum-business-foundations/how-to-become-quantum-ready.mdx index e5027bcbc46..504184646d8 100644 --- a/learning/courses/quantum-business-foundations/how-to-become-quantum-ready.mdx +++ b/learning/courses/quantum-business-foundations/how-to-become-quantum-ready.mdx @@ -216,8 +216,8 @@ Progress your own work in collaboration with peers and IBM Quantum experts. Here Bookmark these pages to ensure you have access to these IBM Quantum industry-leading resources: -* [IBM Quantum Computing](https://quantum.cloud.ibm.com/): Login with your IBMid and navigate with the application switcher in the upper right hand corner to explore the suite of applications to support your quantum needs: - * [IBM Quantum Platform](https://quantum.cloud.ibm.com/) to access an IBM quantum computer on the cloud +* [IBM Quantum Computing](/): Login with your IBMid and navigate with the application switcher in the upper right hand corner to explore the suite of applications to support your quantum needs: + * [IBM Quantum Platform](/) to access an IBM quantum computer on the cloud * [IBM Quantum Learning](/learning) to take a course, explore teaching modules, and start experimenting with Composer (coming soon) * [IBM Quantum Documentation](/docs) to ensure you get the most of IBM tools and services * [IBM Research Blog](https://research.ibm.com/blog): Stay up to date with the latest news, research, and events from IBM Research diff --git a/learning/courses/quantum-business-foundations/quantum-computing-fundamentals.mdx b/learning/courses/quantum-business-foundations/quantum-computing-fundamentals.mdx index 6e626b05339..940b9ecf21e 100644 --- a/learning/courses/quantum-business-foundations/quantum-computing-fundamentals.mdx +++ b/learning/courses/quantum-business-foundations/quantum-computing-fundamentals.mdx @@ -154,7 +154,7 @@ True or false: Quantum circuits are not physical devices. -True. A quantum circuit is an abstract representation of a set of instructions that make up a quantum algorithm. We can use a visual tool like the IBM [Composer](https://quantum.cloud.ibm.com/composer) or a programming language like [Qiskit](/docs/guides) to construct quantum circuits. +True. A quantum circuit is an abstract representation of a set of instructions that make up a quantum algorithm. We can use a visual tool like the IBM [Composer](/composer) or a programming language like [Qiskit](/docs/guides) to construct quantum circuits. diff --git a/learning/courses/quantum-business-foundations/quantum-technology.mdx b/learning/courses/quantum-business-foundations/quantum-technology.mdx index c18b984249a..548753584fe 100644 --- a/learning/courses/quantum-business-foundations/quantum-technology.mdx +++ b/learning/courses/quantum-business-foundations/quantum-technology.mdx @@ -20,7 +20,7 @@ By the end of this module, you should be able to: IBM Quantum Platform provides a suite of quantum computing tools that brings together all of the research and development resources that users need to do great work, in one place. Users can create an account and sign in to get access to IBM quantum computers, view computer details, track workloads, and access enablement material in Documentation and Learning. -* [Home page](https://quantum.cloud.ibm.com/) serves as the primary starting point for the product ecosystem, where users can get their API keys, view a summary of their instances and usage information, view recent job details, and access helpful links to other places across platform. +* [Home page](/) serves as the primary starting point for the product ecosystem, where users can get their API keys, view a summary of their instances and usage information, view recent job details, and access helpful links to other places across platform. * [Documentation](/docs) aggregates Qiskit documentation, service documentation, and API reference information into one location, organized in a way that supports users' natural workflows. * [Learning](/learning) is the home for educational material including courses and teaching modules, and the interactive Circuit Composer (coming soon). This combination graphical and code editor allows users to prototype, simulate, and debug circuits visually, and then run them on IBM quantum computers. diff --git a/learning/courses/quantum-chem-with-vqe/ground-state.ipynb b/learning/courses/quantum-chem-with-vqe/ground-state.ipynb index 573a61475f6..4bd7e8fc134 100644 --- a/learning/courses/quantum-chem-with-vqe/ground-state.ipynb +++ b/learning/courses/quantum-chem-with-vqe/ground-state.ipynb @@ -446,7 +446,7 @@ "id": "deaf4bb5-032e-4d86-a517-29111acaf53f", "metadata": {}, "source": [ - "You can view the progress of your job on the IBM Quantum® Platform under [Workloads](https://quantum.cloud.ibm.com/workloads)." + "You can view the progress of your job on the IBM Quantum® Platform under [Workloads](/workloads)." ] }, { diff --git a/learning/courses/quantum-computing-in-practice/running-quantum-circuits.ipynb b/learning/courses/quantum-computing-in-practice/running-quantum-circuits.ipynb index 7093f654d31..4e7bf937ba4 100644 --- a/learning/courses/quantum-computing-in-practice/running-quantum-circuits.ipynb +++ b/learning/courses/quantum-computing-in-practice/running-quantum-circuits.ipynb @@ -33,7 +33,7 @@ "\n", "The instructions for the microwave pulse go from your computer, through the cloud, and to room-temperature control electronics, which interpret those instructions and physically generate the pulses. After the room-temperature control boxes create the pulses, they travel through cables into a dilution refrigerator and eventually to the quantum chip. The signal goes into the resonators, through a wirebond, and then flows down the transmission line into our qubits.\n", "\n", - "IBM has dozens of quantum computers around the world, and we've recently upgraded our fleet to exclusively have processors larger than 100 qubits. Some of them are located in an IBM quantum data center in upstate New York and deployed over the cloud for everyone's use — and some of them are dedicated, on-premises systems that support partners in the IBM Quantum® Network. You can log into [quantum.cloud.ibm.com](https://quantum.cloud.ibm.com) to see which processors you have access to.\n", + "IBM has dozens of quantum computers around the world, and we've recently upgraded our fleet to exclusively have processors larger than 100 qubits. Some of them are located in an IBM quantum data center in upstate New York and deployed over the cloud for everyone's use — and some of them are dedicated, on-premises systems that support partners in the IBM Quantum® Network. You can log into [quantum.cloud.ibm.com](/) to see which processors you have access to.\n", "\n", "Each processor lists three performance metrics, which we discussed in the previous lesson, but as a reminder, they are: qubit count, EPLG, and CLOPS.\n", "\n", diff --git a/learning/courses/quantum-computing-in-practice/simulating-nature.ipynb b/learning/courses/quantum-computing-in-practice/simulating-nature.ipynb index 744f4ec4e2d..6415721a00d 100644 --- a/learning/courses/quantum-computing-in-practice/simulating-nature.ipynb +++ b/learning/courses/quantum-computing-in-practice/simulating-nature.ipynb @@ -279,7 +279,7 @@ "\n", "The next step involves removing the “bad” qubits from the list of physical qubits available for the experiment. A qubit can become “bad” for various reasons. Sometimes it’s simply a matter of poor calibration, which can be fixed by recalibrating. In other cases, the issue is more complex and related to what’s known as a two-level system (TLS) defect. These TLS defects cause fluctuations in qubit parameters and relaxation. Resolving this often requires warming up the entire system and then cooling it down again—a process that can take some time and isn’t feasible when accessing quantum hardware remotely via the cloud.\n", "\n", - "For now, the simplest approach is to exclude these problematic qubits from the pool of physical qubits that will be used in the experiment. [IBM Quantum Platform](https://quantum.cloud.ibm.com/computers)® makes it easy to identify which qubits are underperforming on a QPU. You can either open the QPU and visualize their characteristics directly on the platform or download the data from the platform as a CSV file. Next, create a list of qubits to exclude and remove them from the total set of physical qubits on the device.\n", + "For now, the simplest approach is to exclude these problematic qubits from the pool of physical qubits that will be used in the experiment. [IBM Quantum Platform](/computers)® makes it easy to identify which qubits are underperforming on a QPU. You can either open the QPU and visualize their characteristics directly on the platform or download the data from the platform as a CSV file. Next, create a list of qubits to exclude and remove them from the total set of physical qubits on the device.\n", "\n", "![The layout of a quantum computer is shown with a low-performing qubit indicated in pink.](/learning/images/courses/quantum-computing-in-practice/simulating-nature/bad-qubits.svg)\n", "\n", diff --git a/learning/courses/utility-scale-quantum-computing/hardware.ipynb b/learning/courses/utility-scale-quantum-computing/hardware.ipynb index 8919605517f..74d00c7a9df 100644 --- a/learning/courses/utility-scale-quantum-computing/hardware.ipynb +++ b/learning/courses/utility-scale-quantum-computing/hardware.ipynb @@ -50,7 +50,7 @@ "## 2. Backend and Target\n", "\n", "Qiskit provides an API to obtain the information, both static and dynamic, about a quantum device. We use a Backend instance to interface with a device, which includes a Target instance, an abstract machine model that summarizes the pertinent features such as its instruction set architecture (ISA) and any properties or constraints associated with it.\n", - "Let us use these backend instances to get some of the information you see on the [Compute resources](https://quantum.cloud.ibm.com/computers) page\n", + "Let us use these backend instances to get some of the information you see on the [Compute resources](/computers) page\n", "on IBM Quantum® Platform. First, we create a backend instance for a device of interest. In the following, we pick \"ibm_kyoto\" , \"ibm_kawasaki\" or the least busy Eagle machine. Your access to QPUs might differ; update the backend name accordingly." ] }, @@ -234,7 +234,7 @@ "id": "be601762", "metadata": {}, "source": [ - "Let us calculate the median of T1 times of the qubits. Compare the result to the one shown for the device on [IBM Quantum Platform.](https://quantum.cloud.ibm.com/)" + "Let us calculate the median of T1 times of the qubits. Compare the result to the one shown for the device on [IBM Quantum Platform.](/)" ] }, { @@ -423,7 +423,7 @@ "source": [ "As you can see, the errors of readout tend to be larger than those of the 2-qubit operation, which in turn tend to be larger than the 1-qubit operation.\n", "\n", - "Having understood the data structures, we are ready to calculate the median errors for the 'sx' and the 'ecr' gates. Again, compare the results with the ones shown for the device on the [IBM Quantum Platform.](https://quantum.cloud.ibm.com/)" + "Having understood the data structures, we are ready to calculate the median errors for the 'sx' and the 'ecr' gates. Again, compare the results with the ones shown for the device on the [IBM Quantum Platform.](/)" ] }, { diff --git a/learning/courses/utility-scale-quantum-computing/teleportation.ipynb b/learning/courses/utility-scale-quantum-computing/teleportation.ipynb index 158f4a93670..8a62721f968 100644 --- a/learning/courses/utility-scale-quantum-computing/teleportation.ipynb +++ b/learning/courses/utility-scale-quantum-computing/teleportation.ipynb @@ -1272,7 +1272,7 @@ "id": "9b3dbd44-61df-4838-9bdc-d36d6fba5881", "metadata": {}, "source": [ - "You can also check the job status from your [IBM Quantum® dashboard.](https://quantum.cloud.ibm.com/workloads)" + "You can also check the job status from your [IBM Quantum® dashboard.](/workloads)" ] }, { diff --git a/learning/modules/computer-science/vqe.ipynb b/learning/modules/computer-science/vqe.ipynb index 34ea7f722ba..fb567fbc95b 100644 --- a/learning/modules/computer-science/vqe.ipynb +++ b/learning/modules/computer-science/vqe.ipynb @@ -1881,7 +1881,7 @@ "\n", "Rather than relying on simple single-qubit circuits and a straightforward ansatz, the complexity of optimization increases when larger quantum circuits and more complex structured ansätze are required. This highlights a well-known challenge in VQEs: the overhead of the optimizer.\n", "\n", - "Researchers continue to develop various advanced methodologies that can use quantum computers for chemistry problems. You can access a variety of educational materials at [IBM Quantum Learning](https://quantum.cloud.ibm.com/learning/en)." + "Researchers continue to develop various advanced methodologies that can use quantum computers for chemistry problems. You can access a variety of educational materials at [IBM Quantum Learning](/learning)." ] }, { diff --git a/scripts/js/commands/checkInternalLinks.ts b/scripts/js/commands/checkInternalLinks.ts index f84db98212d..4d1a3994828 100644 --- a/scripts/js/commands/checkInternalLinks.ts +++ b/scripts/js/commands/checkInternalLinks.ts @@ -39,7 +39,25 @@ const SYNTHETIC_FILES: string[] = [ "announcements/product-updates.mdx", "announcements/index.mdx", "announcements/product-updates/2025-03-03-new-version-dynamic-circuits.mdx", + "index.mdx", + "registration.mdx", + "users.mdx", + "profile.mdx", + "signin.mdx", + "instances.mdx", + "api/docs/index.mdx", + "access-groups.mdx", + "computers.mdx", + "login.mdx", + "composer.mdx", + "workloads.mdx", + "functions.mdx", + "computers.mdx", "announcements/product-updates/2025-09-25-new-dynamic-circuits.mdx", + "analytics.mdx", + "computersmdx", + "scripts/js/lib/links/ignores.ts", + "computers.mdx", ]; interface Arguments { diff --git a/scripts/js/lib/api/updateLinks.ts b/scripts/js/lib/api/updateLinks.ts index 5644ed054e1..b44b4e2e09c 100644 --- a/scripts/js/lib/api/updateLinks.ts +++ b/scripts/js/lib/api/updateLinks.ts @@ -172,15 +172,18 @@ export function relativizeLink(link: Link): Link | undefined { ["https://quantum.cloud.ibm.com/docs", "/docs"], ["https://quantum.cloud.ibm.com/learning", "/learning"], ]); + const priorPrefix = Array.from(priorPrefixToNewPrefix.keys()).find((prefix) => link.url.startsWith(prefix), ); if (!priorPrefix) { return; } + let [url, anchor] = link.url.split("#"); url = removePrefix(url, priorPrefix); url = removeSuffix(url, ".html"); + if (anchor && anchor !== url) { url = `${url}#${anchor}`; } @@ -188,6 +191,7 @@ export function relativizeLink(link: Link): Link | undefined { const newText = link.url === link.text ? url : undefined; const newPrefix = priorPrefixToNewPrefix.get(priorPrefix)!; const relativeUrl = removePrefix(join(newPrefix, url), "/"); + return { url: `/${relativeUrl}`, text: newText }; } diff --git a/scripts/js/lib/links/InternalLink.ts b/scripts/js/lib/links/InternalLink.ts index 07abafdd963..0dcbe8da354 100644 --- a/scripts/js/lib/links/InternalLink.ts +++ b/scripts/js/lib/links/InternalLink.ts @@ -21,10 +21,6 @@ export class File { readonly anchors: Set; readonly synthetic: boolean; - /** - * path: Path to the file - * anchors: Anchors available in the file - */ constructor(path: string, anchors: Set, synthetic: boolean = false) { this.path = path; this.anchors = anchors; @@ -37,30 +33,27 @@ export class InternalLink { readonly anchor: string; readonly originFiles: Set; - /** - * linkString: Link as it appears in source file - * originFiles: Paths to source file containing link - */ constructor(linkString: string, originFiles: string[]) { if (linkString.startsWith("http")) { throw new Error( `Invalid InternalLink, cannot start with 'http': ${linkString}`, ); } + + // ✅ Normalize backslashes and strip query parameters + linkString = linkString.replace(/\\/g, "/").split("?")[0]; + const splitLink = linkString.split("#", 2); this.value = splitLink[0]; this.anchor = splitLink.length > 1 ? `#${splitLink[1]}` : ""; this.originFiles = new Set(originFiles); } - /* - * Return list of possible paths link could resolve to - */ possibleFilePaths(originFile: string): string[] { - // link is just anchor if (this.value === "") { return [originFile]; } + if ( this.value.startsWith("/docs/images") || this.value.startsWith("/docs/videos") || @@ -74,14 +67,11 @@ export class InternalLink { const relativeToFolder = this.value.startsWith("/") ? DOCS_ROOT : path.dirname(originFile); - // Also remove trailing '/' from path.join + const baseFilePath = path .join(relativeToFolder, this.value) .replace(/\/$/gm, ""); - // File may have different extensions (.mdx or .ipynb), and/or be - // directory with an index file (e.g. `docs/build` should resolve to - // `docs/build/index.mdx`). We return a list of possible filenames. let possibleFilePaths = []; for (let index of ["", "/index"]) { for (let extension of CONTENT_FILE_EXTENSIONS) { @@ -94,8 +84,21 @@ export class InternalLink { /** * Returns true if link is in `existingFiles`, otherwise false. */ + isValid(existingFiles: File[], originFile: string): boolean { const possiblePaths = this.possibleFilePaths(originFile); + + // Treat links to "/", "/index", "./", "./index" as always valid + const normalized = this.value.replace(/\/$/, ""); + if ( + normalized === "" || + normalized === "." || + normalized === "index" || + normalized === "./index" + ) { + return true; + } + return possiblePaths.some((filePath) => existingFiles.some( (existingFile) => @@ -111,23 +114,20 @@ export class InternalLink { * Returns a string with a suggested replacement for a broken link * if exists a link similar enough to the broken one */ + didYouMean(existingFiles: File[]): string | null { - // Minimum similarity between 0 and 1 that the suggested link should have const MIN_SIMILARITY = 0.5; - - // Find a new valid link let minScoreLink = Number.MAX_SAFE_INTEGER; - let suggestionPath: String = ""; + let suggestionPath: string = ""; let suggestionPathAnchors: string[] = []; existingFiles.forEach((file) => { - // We need to add the initial `/` to the file paths. - // E.g. docs/guides/my-guide.mdx -> /docs/guides/my-guide.mdx const filePath = `/${file.path}`; const candidatePath = filePath.match(/^\/public\//) ? filePath.replace(/^\/public/, "") : filePath.replace(/\.[^\/.]+$/, ""); - let score = levenshtein.get(this.value, candidatePath); + + const score = levenshtein.get(this.value, candidatePath); if (score < minScoreLink) { minScoreLink = score; suggestionPath = candidatePath; @@ -135,36 +135,35 @@ export class InternalLink { } }); - const lengthLongestPath = - this.value.length > suggestionPath.length - ? this.value.length - : suggestionPath.length; + const lengthLongestPath = Math.max( + this.value.length, + suggestionPath.length, + ); const scoreLinkNormalized = 1 - minScoreLink / lengthLongestPath; if (scoreLinkNormalized < MIN_SIMILARITY) { return null; } - if (this.anchor == "") { + if (this.anchor === "") { return `❓ Did you mean '${suggestionPath}'?`; } - // Find a new valid anchor let minScoreAnchor = Number.MAX_SAFE_INTEGER; - let suggestionAnchor: String = ""; + let suggestionAnchor: string = ""; suggestionPathAnchors.forEach((anchor) => { - let score = levenshtein.get(this.anchor, anchor); + const score = levenshtein.get(this.anchor, anchor); if (score < minScoreAnchor) { minScoreAnchor = score; suggestionAnchor = anchor; } }); - const lengthLongestAnchor = - this.anchor.length > suggestionAnchor.length - ? this.anchor.length - : suggestionAnchor.length; + const lengthLongestAnchor = Math.max( + this.anchor.length, + suggestionAnchor.length, + ); const scoreAnchorNormalized = 1 - minScoreAnchor / lengthLongestAnchor; if (scoreAnchorNormalized < MIN_SIMILARITY) { @@ -177,8 +176,10 @@ export class InternalLink { /** * Returns an error message if link failed. */ + check(existingFiles: File[]): string | undefined { const failingFiles: string[] = []; + this.originFiles.forEach((originFile) => { if (this.isValid(existingFiles, originFile)) { return; @@ -190,8 +191,6 @@ export class InternalLink { return failingFiles.length === 0 ? undefined - : `❌ Could not find link '${this.value}${ - this.anchor - }'. Appears in:\n${failingFiles.sort().join("\n")}`; + : `❌ Could not find link '${this.value}${this.anchor}'. Appears in:\n${failingFiles.sort().join("\n")}`; } }