Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: [M3-8620] – Update docs links in Cloud #11003

Merged
merged 6 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/development-guide/15-api-events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Events

In order to display Events, Cloud Manager polls the [account/events](https://www.linode.com/docs/api/account/#events-list) endpoint at a 16 second interval, or every 2 seconds if there are β€œin-progress” events.
In order to display Events, Cloud Manager polls the [account/events](https://techdocs.akamai.com/linode-api/reference/get-events) endpoint at a 16 second interval, or every 2 seconds if there are β€œin-progress” events.

In order to display these messages in the application (Notification Center, /events page), we compose messages according to the Event key (`EventAction`). Each key requires an entry and set of custom messages for each status (`EventStatus`), dictated by API specs. Not every Status is required for a given Action.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@linode/manager": Changed
---

Update docs links to use latest techdocs.akamai.com URLs ([#11003](https://github.com/linode/manager/pull/11003))
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { testRegions } from 'support/util/regions';
*
* See Linode API v4 documentation for more information.
*
* @link https://www.linode.com/docs/api/images/#image-upload
* @link https://techdocs.akamai.com/linode-api/reference/post-upload-image
*
* @param region - Image upload region.
* @param data - Data to upload.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ export const Default: StoryObj<DocsLinkProps> = {
const meta: Meta<DocsLinkProps> = {
argTypes: {},
args: {
href: 'https://www.linode.com/docs/products/compute/compute-instances/faqs',
href:
'https://techdocs.akamai.com/cloud-computing/docs/faqs-for-compute-instances',
label: 'Custom Doc Link Label',
},
component: DocsLink,
Expand Down
11 changes: 3 additions & 8 deletions packages/manager/src/components/Encryption/constants.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Link } from 'src/components/Link';

/* Disk Encryption constants */
const DISK_ENCRYPTION_GUIDE_LINK =
'https://www.linode.com/docs/products/compute/compute-instances/guides/local-disk-encryption';
'https://techdocs.akamai.com/cloud-computing/docs/local-disk-encryption';

export const DISK_ENCRYPTION_GENERAL_DESCRIPTION = (
<>
Expand All @@ -18,16 +18,11 @@ export const DISK_ENCRYPTION_GENERAL_DESCRIPTION = (
export const DISK_ENCRYPTION_DISTRIBUTED_DESCRIPTION =
'Distributed Compute Instances are secured using disk encryption. Encryption and decryption are automatically managed for you.';

const DISK_ENCRYPTION_UPDATE_PROTECT_CLUSTERS_DOCS_LINK =
'https://www.linode.com/docs/products/compute/compute-instances/guides/local-disk-encryption/';

export const DISK_ENCRYPTION_UPDATE_PROTECT_CLUSTERS_COPY = (
<>
Disk encryption is now standard on Linodes.{' '}
<Link to={DISK_ENCRYPTION_UPDATE_PROTECT_CLUSTERS_DOCS_LINK}>
Learn how
</Link>{' '}
to update and protect your clusters.
<Link to={DISK_ENCRYPTION_GUIDE_LINK}>Learn how</Link> to update and protect
your clusters.
</>
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export const Default: Story = {
disabledCreateButton: false,
docsLabel: 'Docs',
docsLink:
'https://www.linode.com/docs/products/compute/compute-instances/faqs/',
'https://techdocs.akamai.com/cloud-computing/docs/faqs-for-compute-instances',
entity: 'My Entity',
extraActions: <Button buttonType="secondary">Import a Zone</Button>,
loading: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ describe('LandingHeader', () => {
const { getByText } = renderWithTheme(
<LandingHeader
docsLabel="Docs"
docsLink="https://www.linode.com/docs/products/compute/compute-instances/faqs/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/faqs-for-compute-instances"
/>
);
expect(getByText('Docs')).toBeInTheDocument();
Expand Down
4 changes: 2 additions & 2 deletions packages/manager/src/components/Link.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ export const External: StoryObj<LinkProps> = {
render: (args: LinkProps) => (
<Link
{...args}
to="https://www.linode.com/docs/products/compute/compute-instances/faqs"
to="https://techdocs.akamai.com/cloud-computing/docs/faqs-for-compute-instances"
>
https://www.linode.com/docs/products/compute/compute-instances/faqs
https://techdocs.akamai.com/cloud-computing/docs/faqs-for-compute-instances
</Link>
),
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const LinodeResizeAllocationError = () => {
The current disk size of your Linode is too large for the new service
plan. Please resize your disk to accommodate the new plan. You can read
our{' '}
<Link to="https://www.linode.com/docs/platform/disk-images/resizing-a-linode/">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/resize-a-compute-instance">
Resize Your Linode
</Link>{' '}
guide for more detailed instructions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Components constants
// ====================
export const NETWORK_TRANSFER_USAGE_AND_COST_LINK =
'https://www.linode.com/docs/products/platform/get-started/guides/network-transfer/';
'https://techdocs.akamai.com/cloud-computing/docs/network-transfer-usage-and-costs';

// ====================
// Test constants
Expand Down
6 changes: 3 additions & 3 deletions packages/manager/src/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,11 @@ export const ONSITE_URL_REGEX = /^([A-Za-z0-9/\.\?=&\-~]){1,2000}$/;

// Firewall links
export const CREATE_FIREWALL_LINK =
'https://www.linode.com/docs/products/networking/cloud-firewall/guides/create-a-cloud-firewall/';
'https://techdocs.akamai.com/cloud-computing/docs/create-a-cloud-firewall';
export const FIREWALL_GET_STARTED_LINK =
'https://www.linode.com/docs/products/networking/cloud-firewall/get-started/';
'https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-cloud-firewalls';
export const FIREWALL_LIMITS_CONSIDERATIONS_LINK =
'https://www.linode.com/docs/products/networking/cloud-firewall/#limits-and-considerations';
'https://techdocs.akamai.com/cloud-computing/docs/cloud-firewall#limits-and-considerations';

// A/B Testing LD metrics keys for DX Tools
export const LD_DX_TOOLS_METRICS_KEYS = {
Expand Down
4 changes: 2 additions & 2 deletions packages/manager/src/factories/featureFlags.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Factory from 'src/factories/factoryProxy';

import { ProductInformationBannerFlag } from 'src/featureFlags';
import type { ProductInformationBannerFlag } from 'src/featureFlags';

export const productInformationBannerFactory = Factory.Sync.makeFactory<ProductInformationBannerFlag>(
{
Expand All @@ -13,6 +13,6 @@ export const productInformationBannerFactory = Factory.Sync.makeFactory<ProductI
key: Factory.each((i) => `product-information-banner-${i}`),
// safe
message:
'Store critical data and media files with S3-Compatible Object Storage. <a target="_blank" href="https://www.linode.com/docs/products/storage/object-storage/">New Availability: Atlanta</a>',
'Store critical data and media files with S3-Compatible Object Storage. <a target="_blank" href="https://techdocs.akamai.com/cloud-computing/docs/object-storage">New Availability: Atlanta</a>',
}
);
2 changes: 1 addition & 1 deletion packages/manager/src/features/Account/AccountLanding.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ const AccountLanding = () => {
if (isBillingTabSelected) {
landingHeaderProps.docsLabel = 'How Linode Billing Works';
landingHeaderProps.docsLink =
'https://www.linode.com/docs/guides/how-linode-billing-works/';
'https://techdocs.akamai.com/cloud-computing/docs/understanding-how-billing-works';
landingHeaderProps.createButtonText = 'Make a Payment';
if (!isAkamaiAccount) {
landingHeaderProps.onButtonClick = () =>
Expand Down
2 changes: 1 addition & 1 deletion packages/manager/src/features/Backups/BackupDrawer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ all new Linodes will automatically be backed up.`
Three backup slots are executed and rotated automatically: a daily
backup, a 2-7 day old backup, and an 8-14 day old backup. See our
{` `}
<Link to="https://www.linode.com/docs/platform/disk-images/linode-backup-service/">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/backup-service">
guide on Backups
</Link>{' '}
for more information on features and limitations.{' '}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ export const InvoiceDetail = () => {
This invoice may include Linode Compute Instances that have been
powered off as the data is maintained and resources are still
reserved. If you no longer need powered-down Linodes, you can{' '}
<Link to="https://www.linode.com/docs/products/platform/billing/guides/stop-billing/">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/stop-further-billing">
{' '}
remove the service
</Link>{' '}
Expand Down
19 changes: 10 additions & 9 deletions packages/manager/src/features/Billing/PdfGenerator/utils.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
import {
Invoice,
InvoiceItem,
Payment,
TaxSummary,
} from '@linode/api-v4/lib/account';
import JSPDF from 'jspdf';
import autoTable, { CellHookData } from 'jspdf-autotable';
import autoTable from 'jspdf-autotable';
import { pathOr } from 'ramda';

import { ADDRESSES } from 'src/constants';
Expand All @@ -15,6 +8,14 @@ import { MAGIC_DATE_THAT_DC_SPECIFIC_PRICING_WAS_IMPLEMENTED } from 'src/utiliti
import { getShouldUseAkamaiBilling } from '../billingUtils';

import type { Region } from '@linode/api-v4';
import type {
Invoice,
InvoiceItem,
Payment,
TaxSummary,
} from '@linode/api-v4/lib/account';
import type JSPDF from 'jspdf';
import type { CellHookData } from 'jspdf-autotable';

/**
* Margin that has to be applied to every item added to the PDF.
Expand Down Expand Up @@ -241,7 +242,7 @@ export const createInvoiceTotalsTable = (doc: JSPDF, invoice: Invoice) => {
}

const footerText =
'This invoice may include Linode Compute Instances that have been powered off as the data is maintained and resources are still reserved. If you no longer need powered-down Linodes, you can remove the service (https://www.linode.com/docs/products/platform/billing/guides/stop-billing/) from your account.';
'This invoice may include Linode Compute Instances that have been powered off as the data is maintained and resources are still reserved. If you no longer need powered-down Linodes, you can remove the service (https://techdocs.akamai.com/cloud-computing/docs/stop-further-billing) from your account.';
const textHeight = doc.getTextDimensions(footerText).h;
const bottomMargin = pageMargin;
const pageHeight = doc.internal.pageSize.height;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ const DatabaseCreate = () => {
</Typography>
<Typography>
By default, all public and private connections are denied.{' '}
<Link to="https://www.linode.com/docs/products/databases/managed-databases/guides/manage-access-controls/">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/manage-access-controls">
Learn more
</Link>
.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { Database } from '@linode/api-v4/lib/databases/types';
import Grid from '@mui/material/Unstable_Grid2';
import * as React from 'react';

Expand All @@ -11,6 +10,8 @@ import AccessControls from '../AccessControls';
import ClusterConfiguration from './DatabaseSummaryClusterConfiguration';
import ConnectionDetails from './DatabaseSummaryConnectionDetails';

import type { Database } from '@linode/api-v4/lib/databases/types';

interface Props {
database: Database;
disabled?: boolean;
Expand All @@ -24,7 +25,7 @@ export const DatabaseSummary: React.FC<Props> = (props) => {
<Typography>
Add IPv4 addresses or ranges that should be authorized to access this
cluster. All other public and private connections are denied.{' '}
<Link to="https://www.linode.com/docs/products/databases/managed-databases/guides/manage-access-controls/">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/manage-access-controls">
Learn more
</Link>
.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ const DatabaseLanding = () => {
}}
createButtonText="Create Database Cluster"
disabledCreateButton={isRestricted}
docsLink="https://www.linode.com/docs/products/databases/managed-databases/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/managed-databases"
onButtonClick={() => history.push('/databases/create')}
title="Database Clusters"
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ export const gettingStartedGuides: ResourcesLinkSection = {
links: [
{
text: 'Overview of Managed Databases',
to: 'https://www.linode.com/docs/products/databases/managed-databases/',
to: 'https://techdocs.akamai.com/cloud-computing/docs/managed-databases',
},
{
text: 'Get Started with Managed Databases',
to:
'https://www.linode.com/docs/products/databases/managed-databases/get-started/',
'https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-managed-databases',
},
{
text: 'Choosing a Database Engine',
to:
'https://www.linode.com/docs/products/databases/managed-databases/guides/database-engines/',
'https://techdocs.akamai.com/cloud-computing/docs/database-engines-and-plans',
},
],
moreInfo: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ export const CreateDomain = () => {
<DocumentTitleSegment segment="Create Domain" />
<LandingHeader
docsLabel="Docs"
docsLink="https://www.linode.com/docs/guides/dns-manager/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/dns-manager"
title="Create"
/>
<StyledGrid>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export const DomainDetail = () => {
/>
}
docsLabel="Docs"
docsLink="https://www.linode.com/docs/guides/dns-manager/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/dns-manager"
title="Domain Details"
/>
{location.state && location.state.recordError && (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,21 @@ export const gettingStartedGuides: ResourcesLinkSection = {
links: [
{
text: 'Overview of DNS Manager',
to: 'https://www.linode.com/docs/products/networking/dns-manager/',
to: 'https://techdocs.akamai.com/cloud-computing/docs/dns-manager',
},
{
text: 'Getting Started with DNS Manager',
to:
'https://www.linode.com/docs/products/networking/dns-manager/get-started/',
'https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-dns-manager',
},
{
text: 'Create a Domain Zone',
to:
'https://www.linode.com/docs/products/networking/dns-manager/guides/create-domain/',
to: 'https://techdocs.akamai.com/cloud-computing/docs/create-a-domain',
},
],
moreInfo: {
text: 'View additional DNS Manager guides',
to: 'https://www.linode.com/docs/products/networking/dns-manager/guides/',
to: 'https://techdocs.akamai.com/cloud-computing/docs/dns-manager',
},
title: 'Getting Started Guides',
};
Expand Down
2 changes: 1 addition & 1 deletion packages/manager/src/features/Domains/DomainsLanding.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ export const DomainsLanding = (props: DomainsLandingProps) => {
Import a Zone
</StyledButon>
}
docsLink="https://www.linode.com/docs/platform/manager/dns-manager/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/dns-manager"
entity="Domain"
onButtonClick={navigateToCreate}
title="Domains"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const backup: PartialEventMap<'backups'> = {
<>
Backup could <strong>not</strong> be <strong>restored</strong> for{' '}
{e.entity!.label}.{' '}
<Link to="https://www.linode.com/docs/products/storage/backups/#limits-and-considerations">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/backup-service#limits-and-considerations">
Learn more about limits and considerations
</Link>
.
Expand Down
4 changes: 2 additions & 2 deletions packages/manager/src/features/Events/factories/disk.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export const disk: PartialEventMap<'disk'> = {
<>
Image <EventLink event={e} to="secondaryEntity" /> could{' '}
<strong>not</strong> be <strong>created</strong>.{' '}
<Link to="https://www.linode.com/docs/products/tools/images/#technical-specifications">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/images#technical-specifications">
Learn more about image technical specifications
</Link>
.
Expand Down Expand Up @@ -155,7 +155,7 @@ export const disk: PartialEventMap<'disk'> = {
'Disk resize failed toast'
);
}}
to="https://www.linode.com/docs/products/compute/compute-instances/guides/disks-and-storage/"
to="https://techdocs.akamai.com/cloud-computing/docs/manage-disks-on-a-compute-instance"
>
Learn more
</Link>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ export const linode: PartialEventMap<'linode'> = {
<>
Snapshot backup <strong>failed</strong> on Linode{' '}
<EventLink event={e} to="entity" />.{' '}
<Link to="https://www.linode.com/docs/products/storage/backups/#limits-and-considerations">
<Link to="https://techdocs.akamai.com/cloud-computing/docs/backup-service#limits-and-considerations">
Learn more about limits and considerations
</Link>
.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ export const FirewallDetail = () => {
pathname: `/firewalls/${firewall.label}`,
}}
docsLabel="Docs"
docsLink="https://linode.com/docs/platform/cloud-firewall/getting-started-with-cloud-firewall/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-cloud-firewalls"
title="Firewall Details"
/>
{secureVMFirewallBanner && secureVMFirewallBanner.firewallDetails && (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ const FirewallLanding = () => {
) : undefined
}
breadcrumbProps={{ pathname: '/firewalls' }}
docsLink="https://linode.com/docs/platform/cloud-firewall/getting-started-with-cloud-firewall/"
docsLink="https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-cloud-firewalls"
entity="Firewall"
onButtonClick={onOpenCreateDrawer}
title="Firewalls"
Expand Down
Loading
Loading