Skip to content

Commit

Permalink
Add AlexJS to check for sensitive language
Browse files Browse the repository at this point in the history
  • Loading branch information
Cristiano Betta committed Dec 13, 2019
1 parent 02010d7 commit 167f244
Show file tree
Hide file tree
Showing 77 changed files with 1,785 additions and 225 deletions.
6 changes: 6 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,9 @@ destructors
callout
callouts
Cocoapods
Safelist
safelist
Safelisting
safelisting
safelisted
Safelisted
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- alex disable japanese -->

# Contributing

<!-- vscode-markdown-toc -->
Expand All @@ -21,8 +23,8 @@

## <a name='Background'></a>Background

The key purpose for this project is to allow for easy creation and deployment of
microcopy for the [Box.dev][boxdev] site.
The key purpose for this project is to allow for the creation and deployment of
microcopy, guides, and pages for the [Box.dev][boxdev] site.

### <a name='Projectlayout'></a>Project layout

Expand Down Expand Up @@ -138,10 +140,10 @@ Make sure all tests and linting passes before committing changes.
### <a name='Addingindexpages'></a>Adding index pages

Guides are rendered slightly different when they are index pages. Index pages
are simply pages named `index.md` and will automatically list all guides and
are pages named `index.md` and will automatically list all guides and
nested in that folder (and any folders within that folder).

To create an index page, simply run:
To create an index page run:

```shell
yarn new path/to/index "Index page title"
Expand Down
2 changes: 1 addition & 1 deletion content/guides/api-calls/ensure-consistency.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ alias_paths: []

# Ensure Consistency

A few of the Box APIs support special headers to ensure consistency between your
A few of the Box APIs support headers to control consistency between your
application and Box.

## Etag, If-Match, and If-None-Match
Expand Down
2 changes: 1 addition & 1 deletion content/guides/api-calls/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ alias_paths:
# API Calls

The Box API is a restful API that attempts to follow common HTTP standards
where possible. The following guides take a deep dive into some of the useful
where possible. The following guides take a look at some of the useful
features and common mistakes that a developer can encounter when working with
these APIs.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ notes: |-
Lazy copy of old docs. Needs rethinking.
---

<!-- alex disable failed -->

# Common Errors

The Box APIs uses [HTTP status codes][status-codes] to communicate if a request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ alias_paths: []

# Rate Limits

Most of the Box APIs have rate limits in place in order to prevent abuse by
Most of the Box APIs have rate limits in place in order to prevent misuse by
third-party services or users.

## Per API rate limits
Expand Down
6 changes: 3 additions & 3 deletions content/guides/api-calls/permissions-and-errors/scopes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ scopes.

## About scopes

Just as users have certain permissions to access items like files and folders
within Box, applications have their own set of permissions to perform certain
actions on behalf of a Box user or a Box enterprise.
Similar to how users have certain permissions to access items like files and
folders within Box, applications have their own set of permissions to perform
certain actions on behalf of a Box user or a Box enterprise.

The name for a set of permissions for an application is a "scope". By selecting
the correct scopes for your application you can enable your application to
Expand Down
2 changes: 2 additions & 0 deletions content/guides/applications/custom-skills/approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ related_resources: []
alias_paths: []
---

<!-- alex disable whitelist -->

# Approval

Custom Skills will need to be enabled on a folder by the enterprise's Box Admin
Expand Down
8 changes: 4 additions & 4 deletions content/guides/applications/custom-skills/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ alias_paths:
# Customs Skills

A Custom Skill, or Box Skill is a type of application that performs custom
processing for files uploaded to Box. Skills are designed to make it easy to use
third-party Machine Learning services to automatically extract information from
files uploaded to Box.
processing for files uploaded to Box. Skills are designed to make it
straightforward to use third-party Machine Learning services to automatically
extract information from files uploaded to Box.

<ImageFrame shadow>
![Skills example](./images/skills-example.png)
Expand Down Expand Up @@ -46,5 +46,5 @@ A Custom Skill is best used when the application:

- Wants to only add metadata to files uploaded to Box
- Does not want to upload new files or perform any other API calls
- Wants to have a simple way to pass files to Machine Learning services without
- Wants to have way to pass files to Machine Learning services without
having to handle authentication
10 changes: 5 additions & 5 deletions content/guides/applications/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ related_guides:
- authentication/select
required_guides: []
related_resources: []
alias_paths:
alias_paths:
- /docs/use-case-recipes
- /v2/docs/box-api-recipes
---
Expand Down Expand Up @@ -79,9 +79,9 @@ Example use cases for Custom Apps include:
| **Features** | Limited API access |

A Custom Skill, or Box Skill is a type of application that performs custom
processing for files uploaded to Box. Skills are designed to make it easy to use
third-party Machine Learning services to automatically extract information from
files uploaded to Box.
processing for files uploaded to Box. Skills are designed to make it possible to
use third-party Machine Learning services to automatically extract information
from files uploaded to Box.

Box Skills need to be enabled on a folder by a Box Admin. After this an event is
sent to the Skill's application server every time a file is uploaded to the
Expand All @@ -99,7 +99,7 @@ A Custom Skill is best used when the application:

- Wants to only add metadata to files uploaded to Box
- Does not want to upload new files or perform any other API calls
- Wants to have a simple way to pass files to Machine Learning services without
- Wants to have a way to pass files to Machine Learning services without
having to handle authentication

</Message>
Expand Down
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 @@ -106,7 +106,7 @@ client can't get all the data it needs from the first request.

The following example does not require a client callback URL:

- The popup integration executes a REST call using a `download_file_url`
- The popup integration performs a REST call using a `download_file_url`
callback parameter.
- The user clicks OK in the confirmation prompt to accept the popup.
- Box sends a request to the following URL (the primary callback URL plus the
Expand All @@ -118,7 +118,7 @@ The following example does not require a client callback URL:

The following example requires a client callback URL:

- The popup integration executes a REST call using a file-callback parameter.
- The popup integration performs a REST call using a file-callback parameter.
- The user clicks OK in the confirmation prompt to accept the popup.
- The popup displays a page in which Box sends a POST request with the contents
of a file along with the callback parameters to the remote server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ view of a user.
become available to the user.
4. Select an integration from the "More Actions" dropdown. To see available
integrations, a user can right-click a file and select the "More Actions"
sub-menu. Selecting an item from this sub-menu executes the corresponding
sub-menu. Selecting an item from this sub-menu performs the corresponding
feature feature provided by the integration.
5. Grant the integration access to the file. After selecting an integration from
the menu, Box will ask your permission to share the file or folder with the
application. Box displays a confirmation prompt that must accepted before the
integration can be executed.
integration can be performed.

After you accept the confirmation prompt Box executes the integration,
After you accept the confirmation prompt Box runs the integration,
passing the data to the application. The application might display a popup
panel that enables you to complete the action, or it might execute a
panel that enables you to complete the action, or it might run a
server-based process to complete it. The method of completion depends on the
type of integration.
4 changes: 2 additions & 2 deletions content/guides/authentication/jwt/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ alias_paths:

Server-side authentication using JWT one of the most powerful ways to
authenticate to the Box API. JWT is an [open standard](https://jwt.io/)
designed to allow simple and powerful server-to-server authentication.
designed to allow powerful server-to-server authentication.

<ImageFrame border>
![The JWT flow](./jwt-flow.png)
Expand All @@ -33,7 +33,7 @@ permissions.

Server-side authorization using JWT works by creating a claim on the
application's server and then signing this using the application's secret key.
In most cases, the claim simply states that the server is allowed to act on
In most cases, the claim is that the server is allowed to act on
behalf of the Box application.

For this reason a every application that uses JWT has an associated [Service
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/oauth2/with-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ var sdk = new BoxSDK({
## 2. Redirect user

Next, redirect the user to the authorization URL. Most of the SDKs support a
simple way to get the authorization URL for an SDK client.
way to get the authorization URL for an SDK client.

<Tabs>
<Tab title='.NET'>
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/user-types/app-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ authentication and the user is very much tied to the application that created it

## Service Accounts

A Service Account is a special kind of App User that is similar to an Admin User
A Service Account is a unique kind of App User that is similar to an Admin User
yet has no login credentials and can only access Box via the API.

Service Accounts are automatically created when a Custom App is created in the
Expand Down
10 changes: 4 additions & 6 deletions content/guides/best-practices/branding-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ alias_paths:
We’re glad you’re using the Box platform, and we want you to be able to
broadcast to the world that you’re using Box, but it’s very important that your
application not be mistaken for an official Box application. For that reason,
we’ve created a simple guide to what you can and can’t do with our name and
we’ve created a guide to what you can and can’t do with our name and
logo.

## Approved logos
Expand All @@ -32,7 +32,7 @@ this case, you should feel free to use our name and logo to help people find us.
### Contact us

We’re here to help. Many situations can be ambiguous, and we’ll absolutely work
with you to make sure that your app works within our guidelines. [Just contact
with you to make sure that your app works within our guidelines. [Contact
us with any questions][contact].

## Things not to do
Expand Down Expand Up @@ -64,10 +64,8 @@ Don't alter the 'Box' logo in any way when using it in your application.

### Don't use older names

Don't refer to us as `Box.net` or `Boxnet`. Our company is now known simply as
"Box".

contact us – we love talking to developers, and we’re happy to help you.
Don't refer to us as `Box.net` or `Boxnet`. Our company is now known as
"Box" only.

[logos]: https://cloud.box.com/s/v1yn0eyqpxx657brrgcn
[contact]: https://community.box.com/t5/custom/page/page-id/submit_api_questionaire
2 changes: 1 addition & 1 deletion content/guides/best-practices/cors.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ alias_paths:

Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional HTTP
headers to tell browsers to give a web application running at one origin, access
to selected resources from a different origin. A web application executes a
to selected resources from a different origin. A web application performs a
cross-origin HTTP request when it requests a resource that has a different
origin (domain, protocol, or port) from its own.

Expand Down
2 changes: 2 additions & 0 deletions content/guides/collaboration-whitelists/create-whitelist.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ related_resources: []
alias_paths: []
---

<!-- alex disable whitelist -->

# Create Collaboration Whitelist

Creating a new collaboration whitelist will set a new domain, such as
Expand Down
11 changes: 7 additions & 4 deletions content/guides/collaboration-whitelists/delete-whitelist.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,19 @@ related_resources: []
alias_paths: []
---

<!-- alex disable whitelist -->

# Delete Collaboration Whitelist

Deleting a collaboration whitelist entry will remove the ability for
collaborations to be created between your enterprise and the domain listed in
that whitelist.

To delete a collaboration whitelist, supply the domain whitelist entry ID to
the delete request, which is returned when
[creating a new whitelist entry](guide://collaboration-whitelists/create-whitelist)
or
[listing whitelists in the enterprise](guide://collaboration-whitelists/list-whitelists);
the delete request, which is returned when [creating a new whitelist entry][create]
or [listing whitelists in the enterprise][list];

<Samples id='delete_collaboration_whitelist_entries_id' />

[create]: guide://collaboration-whitelists/create-whitelist
[list]: guide://collaboration-whitelists/list-whitelists
2 changes: 2 additions & 0 deletions content/guides/collaboration-whitelists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ related_resources: []
alias_paths: []
---

<!-- alex disable whitelist -->

# Collaboration Whitelists

Within the content and sharing settings for an enterprise, an admin can specify
Expand Down
4 changes: 2 additions & 2 deletions content/guides/embed/box-embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ alias_paths:

# Box Embed

Box Embed is a HTML-based framework that makes it easy to embed the entire Box
experience anywhere people work. Box Embed provides the ability to upload,
Box Embed is a HTML-based framework that makes it possible to embed the entire
Box experience anywhere people work. Box Embed provides the ability to upload,
search, comment, share, tag, and most importantly edit files using Box Edit.

## Configure
Expand Down
2 changes: 1 addition & 1 deletion content/guides/embed/box-view/create-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ alias_paths: []
Once a file has been uploaded to the app token application, it may be previewed
using two different methods:

* Direct embed: A simple HTML `<iframe>` component with a custom embed link.
* Direct embed: A standard HTML `<iframe>` component with a custom embed link.
* Customized previewer: A fully customized preview widget using Box UI Elements.

## Direct Embed (`iframe`)
Expand Down
4 changes: 2 additions & 2 deletions content/guides/embed/box-view/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ long as you want to be able to display them.

### How do I fix the CORS error Box gives me when I embed a Box UI Element

To fix the CORS error, you have to whitelist each domain you wish to allow to
make CORS requests. You can whitelist the domain on your application's
To fix the CORS error, you have to allow each domain you wish to allow to
make CORS requests. You can allow the domain on your application's
configuration page within the Box developer console. If you have many
subdomains that you want to use the UI element on, you can use a wildcard for
the subdomain (`https://*.domain.com`). See the
Expand Down
6 changes: 3 additions & 3 deletions content/guides/embed/box-view/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ file viewer with web and mobile applications.
### View Any File

Embed documents, images, videos, 360-degree videos and images, 3D models, and
dozens of other files in any web or mobile app using a simple `<iframe>` or
dozens of other files in any web or mobile app using a standard `<iframe>` or
JavaScript SDK.

### Optimized Viewing Experience

Our Javascript SDK dynamically selects the appropriate viewer for your file to
render instantly and crisply on any web or mobile device.

### Easy to Use
### Ease of Use

Simply upload files to Box via a secure API and receive an embeddable HTML5
Upload files to Box via a secure API and receive an embeddable HTML5
snippet to place into your application's user interface. Plus, your files are
securely stored and manageable in Box.

Expand Down
10 changes: 5 additions & 5 deletions content/guides/embed/box-view/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ application.

## Create App Token App

Box View uses an authentication mechanism called **App Token Auth** to host
files directly within the application as opposed to a specific Box user. This
permits the previewing of files without having to associate the content with a
user.
Box View uses an authentication mechanism called **App Token Auth** to store
files directly within the account of the application as opposed to a specific
Box user. This permits the previewing of files without having to associate the
content with a user.

The first step is to create the application and authorize it through your admin
to begin making API requests to Box.
Expand Down Expand Up @@ -56,7 +56,7 @@ section.
prompt to set up 2FA.
</Message>

Choose the expiration period for your token, either 30 days, 60 days, or set the
Choose the expiration time for your token, either 30 days, 60 days, or set the
token to never expire.

<ImageFrame border width='600' shadow center>
Expand Down
Loading

0 comments on commit 167f244

Please sign in to comment.