Skip to content

Commit

Permalink
Clean up website internal links (#661)
Browse files Browse the repository at this point in the history
  • Loading branch information
wsocha authored Dec 16, 2024
1 parent 24698f3 commit 1dffb83
Show file tree
Hide file tree
Showing 86 changed files with 326 additions and 285 deletions.
8 changes: 4 additions & 4 deletions content/guides/api-calls/permissions-and-errors/scopes.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,19 +325,19 @@ The standard OAuth scopes are also supported when downscoping.
[console]: https://app.box.com/developers/console
[ui-elements]: https://github.com/box/box-ui-elements
[pricing]: https://www.box.com/pricing/platform
[reference]: https://developer.box.com/reference
[reference]: page://reference
<!-- i18n-disable localize-links -->
[at]: g://authentication/tokens
[security]: g://security
[jwt]: g://authentication/jwt
[mu]:page://platform/user-types/#managed-users
[mu]: page://platform/user-types/#managed-users
[au]: g://authentication/jwt/as-user
[uat]: g://authentication/jwt/user-access-tokens
[appaccess]: g://authentication/jwt/jwt-setup/#application-access
[appu]:page://platform/user-types/#app-user
[appu]: page://platform/user-types/#app-user
<!-- i18n-enable localize-links -->
[governance]: https://www.box.com/security/governance-and-compliance
<!-- i18n-disable localize-links -->
[suppress]: g://api-calls/suppress-notifications
[ds]: g://authentication/tokens/downscope
[sa]:page://platform/user-types/#service-account
[sa]: page://platform/user-types/#service-account
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Box provides versioning capabilities for selected API endpoints. The version con

API versioning empowers Box to continually enhance its platform, while also offering third-party developers a reliable avenue for feature updates and deprecations.

To stay informed about the API modifications, monitor the [Changelog](https://developer.box.com/changelog/) and maintain a current email address in the **App Info** section of the Developer Console.
To stay informed about the API modifications, monitor the [Changelog](page://changelog) and maintain a current email address in the **App Info** section of the Developer Console.

## Error examples

Expand Down
4 changes: 2 additions & 2 deletions content/guides/applications/app-types/custom-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ Custom Apps may require approval before use.

[oauth2]: g://authentication/oauth2
[jwt]: g://authentication/jwt
[cc]: g://authentication/client-credentials/
[uie]: g://embed/ui-elements/
[cc]: g://authentication/client-credentials
[uie]: g://embed/ui-elements
[users]: g;//getting-started/user-types/#managed-users/
4 changes: 2 additions & 2 deletions content/guides/applications/app-types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ create.
[devtoken]: g://authentication/tokens/developer-tokens
[custom-apps]: g://applications/app-types/custom-apps
[custom-skills]: g://applications/app-types/custom-skills
[ccg]: g://authentication/client-credentials/
[laa]: g://applications/app-types/limited-access-apps/
[ccg]: g://authentication/client-credentials
[laa]: g://applications/app-types/limited-access-apps
[insights]: https://support.box.com/hc/en-us/articles/20738406915219-Platform-Insights
8 changes: 4 additions & 4 deletions content/guides/applications/app-types/limited-access-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ with a [limited number of endpoints][limited].

## Authentication methods

Limited Access Apps only support App Token authentication.
Limited Access Apps only support App Token authentication.

<CTA to='g://authentication/app-token'>
Learn more about App Tokens
</CTA>

## When to use

A Limited Access App is best used when the application:
A Limited Access App is best used when the application:

- wants to use Box View or only Box's preview services
- only needs to access a [limited number of endpoints][limited]
Expand All @@ -33,11 +33,11 @@ A Limited Access App is best used when the application:

## Approval

Limited Access Apps may require approval before use.
Limited Access Apps may require approval before use.

<CTA to='g://authorization/limited-access-approval'>
Learn how to approve Limited Access Apps
</CTA>

[bv]: g://embed/box-view/
[bv]: g://embed/box-view
[limited]: g://authentication/app-token/endpoints
4 changes: 2 additions & 2 deletions content/guides/applications/web-app-integrations/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ Center. Follow the [Integrations][integrations] guide for more details.

[ca]: g://applications/app-types/custom-apps
[pu]: g://applications/web-app-integrations/types
[uid]:page://platform/appendix/locating-values/#user-ids
[fid]:page://platform/appendix/locating-values/#content-ids
[uid]: page://platform/appendix/locating-values/#user-ids
[fid]: page://platform/appendix/locating-values/#content-ids
[code]: g://authentication/oauth2/without-sdk/#3-user-grants-application-access
[custom-oauth2]: g://authentication/oauth2/oauth2-setup
[devconsole]: https://app.box.com/developers/console
Expand Down
4 changes: 2 additions & 2 deletions content/guides/authentication/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ enhancements.
Developer Tokens should only be used for development or testing purposes and
never in production.

[downscope]: g://authentication/tokens/downscope/
[revoke]: g://authentication/tokens/revoke/
[downscope]: g://authentication/tokens/downscope
[revoke]: g://authentication/tokens/revoke
6 changes: 3 additions & 3 deletions content/guides/authentication/client-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ This error indicates either:

- the client ID and client secret passed are incorrect or are not for the same application,

- the `box_subject_id` cannot be used based on the selected [application access][aa].
- the `box_subject_id` cannot be used based on the selected [application access][aa].

<Message warning>

Expand All @@ -105,8 +105,8 @@ Once you make changes to the app settings, don't forget to [reauthorize][reauth]
<!-- i18n-disable localize-links -->

[devconsole]: https://app.box.com/developers/console
[accesstoken]: e://post-oauth2-token/
[sa]: page://platform/user-types/#service-account/
[accesstoken]: e://post-oauth2-token
[sa]: page://platform/user-types/#service-account
[auth]: g://authorization
[aa]: g://authentication/client-credentials/client-credentials-setup/#application-access
[reauth]: g://authorization/custom-app-approval#re-authorization-on-changes
6 changes: 3 additions & 3 deletions content/guides/authentication/oauth2/without-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,11 +318,11 @@ To learn how to use an Access Token visit our guide on [Making API calls][apic].

<!-- i18n-disable localize-links -->

[auth]: e://get-authorize/
[auth]: e://get-authorize
[ci]: e://get-authorize/#param-client_id
[re]: e://get-authorize/#param-redirect_uri
[co]: e://get-authorize/#param-response_type
[st]: e://get-authorize/#param-state
[thirty]: g://api-calls/permissions-and-errors/expiration
[at]: e://post-oauth2-token/
[apic]: g://api-calls/
[at]: e://post-oauth2-token
[apic]: g://api-calls
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Endpoints related to metadata extraction are currently a beta feature offered su
</Message>

With Box AI API, you can extract metadata from the provided file
and get the result in the form of key-value pairs.
and get the result in the form of key-value pairs.
As input, you can either create a structure using the `fields` parameter, or use an already defined metadata template.
To learn more about creating templates, see [Creating metadata templates in the Admin Console][templates-console] or use the [metadata template API][templates-api].

Expand Down Expand Up @@ -114,7 +114,7 @@ You can use either `fields` or `metadata_template` to specify your structure, bu

### Use `fields` parameter

The `fields` parameter allows you to specify the data you want to extract. Each `fields` object has a subset of parameters you can use to add more information about the searched data.
The `fields` parameter allows you to specify the data you want to extract. Each `fields` object has a subset of parameters you can use to add more information about the searched data.
For example, you can add the field type, description, or even a prompt with some additional context.

```bash
Expand Down Expand Up @@ -216,5 +216,5 @@ The response lists the fields included in the metadata template and their values
[templates-console]: https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates
[templates-api]: g://metadata/templates/create
[overrides]: g://box-ai/ai-agents/ai-agent-overrides
[changelog]: https://developer.box.com/changelog/
[changelog]: page://changelog
[blog]: https://medium.com/box-developer-blog
14 changes: 7 additions & 7 deletions content/guides/box-relay/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ rank: 223
# Box Relay

[Box Relay][boxrelay] is a workflow automation application that enables Box
power users to automate and accelerate business processes centered
around content. Currently, there are two API [endpoints][workflow] developers
can use with more planned to be released in the future. Both were created to
work directly with [manual start flows][manualstart].
power users to automate and accelerate business processes centered
around content. Currently, there are two API [endpoints][workflow] developers
can use with more planned to be released in the future. Both were created to
work directly with [manual start flows][manualstart].

<Message type='notice'>
For more information on how to use these endpoints, refer to our [blog][blog]
For more information on how to use these endpoints, refer to our [blog][blog]
post.
</Message>

Expand All @@ -38,7 +38,7 @@ Please see our [rate limit guide][ratelimit] for more information.

Due to the feature parity, it may be useful to familiarize yourself with
[Box Relay functionality using the Box web app][webapp] before leveraging the
API. As with all API endpoints, we recommend testing via
API. As with all API endpoints, we recommend testing via
[developer sandbox environment][sandbox] to eliminate the risk of impacting
production content.

Expand All @@ -53,7 +53,7 @@ production content.
[relay]: g://api-calls/permissions-and-errors/scopes/#manage-box-relay
<!-- i18n-enable localize-links -->
[boxrelay]: https://support.box.com/hc/en-us/articles/360044196213-Introducing-Box-Relay
[workflow]: https://developer.box.com/reference/resources/workflow/
[workflow]: resource://workflow
[manualstart]: https://support.box.com/hc/en-us/articles/360044628853-Creating-and-Running-a-Manual-Start-Workflow
[blog]: https://medium.com/box-developer-blog/manual-start-workflow-api-box-relay-4f8d0f51b7a4
<!-- i18n-disable localize-links -->
2 changes: 1 addition & 1 deletion content/guides/box-sign/create-sign-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Encountering an error status requires creating a new sign request to retry.
![Status diagram](images/status.png)
</ImageFrame>

[upload]: e://post-files-content/
[upload]: e://post-files-content
[documents]: g://representations/supported-file-types/#documents
[presentations]: g://representations/supported-file-types/#presentations
[uploads]: g://uploads/direct
Expand Down
18 changes: 9 additions & 9 deletions content/guides/cli/cli-docs/jwt-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,23 +197,23 @@ Notification Email: []
- You can also go to the second part of the [OAuth 2.0 Quick Start][three] for a tutorial on how to use the commands.

[cli]: https://github.com/box/boxcli
[auth]: g://authentication/jwt/without-sdk/
[at]: g://authentication/tokens/
[auth]: g://authentication/jwt/without-sdk
[at]: g://authentication/tokens
<!-- i18n-enable localize-links -->
[dc]: https://account.box.com/developers/console
<!-- i18n-disable localize-links -->
[keypair]: g://authentication/jwt/jwt-setup/#public-and-private-key-pair
[sa]: page://platform/user-types/#service-account/
[scopes]: g://api-calls/permissions-and-errors/scopes/
[ag]: g://authorization/custom-app-approval/
[sa]: page://platform/user-types/#service-account
[scopes]: g://api-calls/permissions-and-errors/scopes
[ag]: g://authorization/custom-app-approval
<!-- i18n-enable localize-links -->
[blogpost]: https://medium.com/box-developer-blog/box-api-understanding-security-9fcad7b1d72e
<!-- i18n-disable localize-links -->
[scopes]: g://api-calls/permissions-and-errors/scopes/
[scopes]: g://api-calls/permissions-and-errors/scopes
[aa]: g://authentication/jwt/jwt-setup/#application-access
[three]: g://cli/quick-start/build-commands-help/
[four]: g://cli/quick-start/options-and-bulk-commands/
[three]: g://cli/quick-start/build-commands-help
[four]: g://cli/quick-start/options-and-bulk-commands
[cache]: https://github.com/box/boxcli/blob/master/docs/configure.md#box-configureenvironmentsupdate-name
[ac]: https://github.com/box/boxcli/blob/master/docs/autocomplete.md
[commands]: https://github.com/box/boxcli#command-topics
[qs]: g://cli/quick-start/
[qs]: g://cli/quick-start
2 changes: 1 addition & 1 deletion content/guides/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ advanced CLI user.
[cli-autocomplete]: https://github.com/box/boxcli/blob/main/docs/autocomplete.md
[cli-switch]: https://github.com/box/boxcli/blob/main/docs/configure.md#box-configureenvironmentsswitch-user-userid
[cli-add-config]: https://github.com/box/boxcli/blob/main/docs/configure.md#box-configureenvironmentsadd-path
[qs]: g://cli/quick-start/
[qs]: g://cli/quick-start
[cache]: https://github.com/box/boxcli/blob/main/docs/configure.md#box-configureenvironmentsupdate-name
[jwt]: g://authentication/jwt
[jwt-page]: g://cli/cli-docs/jwt-cli
Expand Down
12 changes: 6 additions & 6 deletions content/guides/cli/quick-start/0-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ This guide will take you through the following steps.
</Next>

[commands]: https://github.com/box/boxcli#command-topics
[one]: g://cli/quick-start/create-oauth-app/
[two]: g://cli/quick-start/install-and-configure/
[three]: g://cli/quick-start/build-commands-help/
[four]: g://cli/quick-start/options-and-bulk-commands/
[five]: g://cli/quick-start/powershell-script-templates/
[six]: g://cli/quick-start/next-steps/
[one]: g://cli/quick-start/create-oauth-app
[two]: g://cli/quick-start/install-and-configure
[three]: g://cli/quick-start/build-commands-help
[four]: g://cli/quick-start/options-and-bulk-commands
[five]: g://cli/quick-start/powershell-script-templates
[six]: g://cli/quick-start/next-steps
2 changes: 1 addition & 1 deletion content/guides/cli/quick-start/1-create-oauth-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ extra steps to set up.

[devconsole]: https://cloud.app.box.com/developers/console
[signup]: https://account.box.com/signup/n/developer
[scopes]: https://developer.box.com/guides/api-calls/permissions-and-errors/scopes/
[scopes]: g://api-calls/permissions-and-errors/scopes
6 changes: 3 additions & 3 deletions content/guides/cli/quick-start/2-install-and-configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Notification Email: []
</Choice>

[cli]: https://github.com/box/boxcli
[auth]: g://authentication/jwt/without-sdk/
[sa]: page://platform/user-types/#service-account/
[at]: g://authentication/tokens/
[auth]: g://authentication/jwt/without-sdk
[sa]: page://platform/user-types/#service-account
[at]: g://authentication/tokens
[dc]: https://app.box.com/developers/console
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,6 @@ For more details on bulk commands read [this document][bulk].

[github]: https://github.com/box/boxcli#command-topics
[df]: https://github.com/box/boxcli/blob/master/docs/folders.md#box-foldersdelete-id
[asuser]: g://authentication/jwt/as-user/
[asuser]: g://authentication/jwt/as-user
[csv]: https://github.com/box/boxcli/blob/main/docs/Bulk%20actions/folders/folders-create.csv
[bulk]: g://cli/cli-docs/bulk-commands
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ Make sure to explore our other [sample scripts][samples] for more use cases.
[script-1]: https://github.com/box/boxcli/tree/main/examples/User%20Creation%20&%20Provisioning
[jwt-cli]: g://cli/cli-docs/jwt-cli
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[step 1]: g://cli/quick-start/create-oauth-app/
[step 1]: g://cli/quick-start/create-oauth-app
[console]: https://app.box.com/developers/console
[auth]: g://authentication/oauth2/oauth2-setup
[samples]: g://cli/scripts
12 changes: 6 additions & 6 deletions content/guides/cli/quick-start/6-next-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ To take the next step, the following resources are recommended:
3. Review [autocomplete][ac] settings.
4. Review all of the [CLI sample scripts][sample-scripts].

[one]: g://cli/quick-start/create-oauth-app/
[two]: g://cli/quick-start/install-and-configure/
[three]: g://cli/quick-start/build-commands-help/
[four]: g://cli/quick-start/options-and-bulk-commands/
[five]: g://cli/quick-start/powershell-script-templates/
[one]: g://cli/quick-start/create-oauth-app
[two]: g://cli/quick-start/install-and-configure
[three]: g://cli/quick-start/build-commands-help
[four]: g://cli/quick-start/options-and-bulk-commands
[five]: g://cli/quick-start/powershell-script-templates
[cache]: https://github.com/box/boxcli/blob/master/docs/configure.md#box-configureenvironmentsupdate-name
[ac]: https://github.com/box/boxcli/blob/master/docs/autocomplete.md
[commands]: https://github.com/box/boxcli#command-topics
[sample-scripts]: https://developer.box.com/guides/cli/scripts/
[sample-scripts]: g://cli/scripts
2 changes: 1 addition & 1 deletion content/guides/cli/scripts/deprovision-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ You have access to these log files:
[scripts]: https://github.com/box/boxcli/tree/main/examples
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[quickstart]: g://cli/quick-start/create-oauth-app/
[quickstart]: g://cli/quick-start/create-oauth-app
[console]: https://app.box.com/developers/console
[auth]: g://authentication/oauth2/oauth2-setup
[examples]:https://github.com/box/boxcli/tree/main/examples/User%20Deprovisioning
Expand Down
2 changes: 1 addition & 1 deletion content/guides/cli/scripts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ get that done.
[4]: g://cli/scripts/report-inactive-users
[5]: g://cli/scripts/metadata-extraction
[6]: g://cli/scripts/user-zones-mass-update
[quickstart]: g://cli/quick-start/create-oauth-app/
[quickstart]: g://cli/quick-start/create-oauth-app
[7]: https://support.box.com/hc/en-us/articles/360043694174-Understanding-Administrator-and-Co-Administrator-Permissions
[8]: g://cli/scripts/slack-integration-mappings
2 changes: 1 addition & 1 deletion content/guides/cli/scripts/manage-groups-collaborations.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,6 @@ You have access to these log files:

[examples]: https://github.com/box/boxcli/tree/main/examples
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[quickstart]: g://cli/quick-start/create-oauth-app/
[quickstart]: g://cli/quick-start/create-oauth-app
[console]: https://app.box.com/developers/console
[auth]: g://authentication/oauth2/oauth2-setup
2 changes: 1 addition & 1 deletion content/guides/cli/scripts/metadata-extraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ You have access to these log files:
[scripts]: https://github.com/box/boxcli/tree/main/examples
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[quickstart]: g://cli/quick-start/create-oauth-app/
[quickstart]: g://cli/quick-start/create-oauth-app
[console]: https://app.box.com/developers/console
[auth]: g://authentication/oauth2/oauth2-setup
[examples]:https://github.com/box/boxcli/tree/main/examples/Metadata%20Extraction
4 changes: 2 additions & 2 deletions content/guides/cli/scripts/report-inactive-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ You have access to these log files:
[scripts]: https://github.com/box/boxcli/tree/main/examples
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[quickstart]: g://cli/quick-start/create-oauth-app/
[boxevents]: https://developer.box.com/reference/resources/event/
[quickstart]: g://cli/quick-start/create-oauth-app
[boxevents]: resource://event
[deprovisionscript]: g://cli/scripts/deprovision-users
[console]: https://app.box.com/developers/console
[auth]: g://authentication/oauth2/oauth2-setup
Expand Down
2 changes: 1 addition & 1 deletion content/guides/cli/scripts/slack-integration-mappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Logs are stored in a `logs` folder located in the main folder. You have access t
This project is a collection of open source examples and should not be treated as an officially supported product. Use at your own risk and as a source of example how to use Box CLI.

[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[oauth-guide]: https://developer.box.com/guides/cli/quick-start/
[oauth-guide]: g://cli/quick-start
[install-slack]: https://support.box.com/hc/en-us/articles/360044195313-Installing-and-Using-the-Box-for-Slack-Integration
[content-layer]: https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack
[1]: https://github.com/box/boxcli/tree/main/examples/Integration%20Mappings
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ collaborators to files and folders in Box.
Once the application is created it will still need to be approved by an
enterprise admin before you will be able to make calls to the Box APIs.

Follow [this guide](g://authorization/custom-app-approval/) to have the
Follow [this guide](g://authorization/custom-app-approval) to have the
application approved in your enterprise.
</Message>

Expand Down Expand Up @@ -76,7 +76,7 @@ collaborators to files and folders in Box.
enterprise admin before you will be able to make calls to any of the Box
APIs that need any of the new permissions.

Follow [this guide](g://authorization/custom-app-approval/) to have the
Follow [this guide](g://authorization/custom-app-approval) to have the
application approved in your enterprise.
</Message>

Expand Down
Loading

0 comments on commit 1dffb83

Please sign in to comment.