Skip to content
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
4 changes: 3 additions & 1 deletion .alexrc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"rejects",
"period",
"fire",
"attacks"
"attacks",
"special",
"straightforward"
]
}
22 changes: 11 additions & 11 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 3

# We use node 14.X
# We use node 18.X
strategy:
matrix:
node-version: [14.x]
node-version: [18.x]

# The following steps are performed for each lint job
steps:
Expand Down Expand Up @@ -56,10 +56,10 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 3

# We use node 14.X
# We use node 18.X
strategy:
matrix:
node-version: [14.x]
node-version: [18.x]

# The following steps are performed for each lint job
steps:
Expand Down Expand Up @@ -95,10 +95,10 @@ jobs:
# Only run for the main branch
if: github.ref == 'refs/heads/main'

# We use node 14.X
# We use node 18.X
strategy:
matrix:
node-version: [14.x]
node-version: [18.x]

# Requires the lint and test jobs to pass first
needs:
Expand Down Expand Up @@ -162,10 +162,10 @@ jobs:
# Only run for the staging branch
if: github.ref == 'refs/heads/staging'

# We use node 14.X
# We use node 18.X
strategy:
matrix:
node-version: [14.x]
node-version: [18.x]

# Requires the lint and test jobs to pass first
needs:
Expand Down Expand Up @@ -214,7 +214,7 @@ jobs:
SLACK_AVATAR: "https://avatars3.githubusercontent.com/u/8659759?s=200&v=4"
with:
args: "Error running `deploy-staging` job in OpenAPI CI"

# The deploy task actually deploys any changes to the en-staging branch
push-to-en-abtest:
# We run this on the latest ubuntu
Expand All @@ -223,10 +223,10 @@ jobs:
# Only run for the staging branch
if: github.ref == 'refs/heads/abtest'

# We use node 14.X
# We use node 18.X
strategy:
matrix:
node-version: [14.x]
node-version: [18.x]

# Requires the lint and test jobs to pass first
needs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/notify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:

strategy:
matrix:
node-version: [14.x]
node-version: [18.x]

steps:
- name: "Trigger Netlify deployment"
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Using the latest Node 14
# Using the latest Node 18
# FROM ubuntu:20.04
FROM node:14
FROM node:18

# Set a working directory to use
WORKDIR /code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ for solution to common errors encountered when working with the Box APIs.
| | |
| **Error** | `item_name_invalid` |
| **Message**| Item name invalid |
<!-- markdownlint-disable no-space-in-code -->
| **Solution** | Verify that the file's name is valid. Box only supports file or folder names that are 255 characters or less. File names containing non-printable characters, names containing the characters `/`, `\`, `<`, `>`, `:`, `|`, `?`, `*`, `—` , names with leading or trailing spaces, and the special names “.” and “..” are also unsupported. |
| | |
| **Error** | `item_name_too_long` |
Expand Down
5 changes: 3 additions & 2 deletions content/guides/getting-started/publish-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ submit your app for approval. Box will review your application
and publish it in the Integrations.

In case of any questions or issues, contact the Partners team:
[email protected]
[`[email protected]`][email]

[integrations]: https://cloud.app.box.com/integrations
[integrations]: https://cloud.app.box.com/integrations
[email]: mailto:[email protected]
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This project has a few prerequisites.
installed with `Homebrew` using `brew install docker-compose`.
* When not using Docker
* [`Node.js`](https://nodejs.org/) for compilation and linting of the API
specification. Ideally Node 12 or above.
specification. Ideally Node 18 or above.
* [`Yarn`](https://yarnpkg.com/) is the Node package manager for this project.
It can be installed with `npm i -g yarn` if Node is installed.
* [`YamlLint`](https://github.com/adrienverge/yamllint) is the linter to validate
Expand All @@ -45,7 +45,7 @@ docker-compose up --build

## Run with Node

To run with Node directly, make sure you have Node 14 or higher installed.
To run with Node directly, make sure you have Node 18 or higher installed.

```sh
yarn install
Expand Down
5 changes: 4 additions & 1 deletion markdownlintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,8 @@
},
"ul-indent": false,
"link-image-reference-definitions": false,
"reference-links-images": false
"reference-links-images": false,
"no-duplicate-heading": false,
"table-pipe-style": false,
"table-column-count": false
}
25 changes: 13 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,22 @@
"new:page:empty": "node -e 'require(\"./src/scripts/from-template\").run(\"template-empty.md\", \"pages\")'"
},
"dependencies": {
"@apidevtools/json-schema-ref-parser": "^9.0.1",
"alex": "^9.0.1",
"axios": "^0.21.2",
"comment-json": "^4.0.4",
"concurrently": "^5.3.0",
"dot-prop": "^6.0.0",
"fs-extra": "^9.0.0",
"glob": "^7.1.6",
"jest": "^26.6.3",
"js-yaml": "^3.13.1",
"@apidevtools/json-schema-ref-parser": "^11.7.2",
"alex": "^11.0.1",
"axios": "^1.7.8",
"comment-json": "^4.2.5",
"concurrently": "^9.1.0",
"dot-prop": "^9.0.0",
"esm": "^3.2.25",
"fs-extra": "^11.2.0",
"glob": "8.1.0",
"jest": "^29.7.0",
"js-yaml": "^4.1.0",
"jsonpath": "^1.0.2",
"markdown-spellcheck": "^1.3.1",
"markdownlint-cli": "^0.32.0",
"markdownlint-cli": "^0.41.0",
"sha1-from-file": "^2.0.1",
"sharp": "^0.26.2",
"sharp": "^0.33.5",
"strip-indent": "^3.0.0",
"watch": "^1.0.2"
}
Expand Down
20 changes: 10 additions & 10 deletions tests/markdown/processor.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ notes: |-

<Foobar id='no1' data-type="type" disabled>
Hello
Extra whitespace around here

Extra whitespace around here

<Message data-disabled='true' warning>
# Title
# Title

This is a paragraph
</Message>
Expand All @@ -33,8 +33,8 @@ notes: |-
[1,2,3].map(i => (
i+1
))
# whitespace above and after:

# whitespace above and after:
\`\`\`
</Tab>
</Tabs>
Expand All @@ -56,7 +56,7 @@ sibling_id: guides
parent_id: guides
next_page_id: guides
previous_page_id: ''
source_url: 'https://github.com/box/developer.box.com/blob/main/content/guides/foo.md'
source_url: https://github.com/box/developer.box.com/blob/main/content/guides/foo.md
---
<Foobar id='no1' data-type="type" disabled>

Expand Down Expand Up @@ -87,7 +87,7 @@ This is a paragraph
i+1
))

# whitespace above and after:
# whitespace above and after:
\`\`\`

</Tab>
Expand All @@ -100,7 +100,7 @@ test('should inline tags', () => {
const contents = `
---
---
<Header
<Header
to='/guides'
centered
>
Expand All @@ -123,7 +123,7 @@ sibling_id: guides
parent_id: guides
next_page_id: guides
previous_page_id: ''
source_url: 'https://github.com/box/developer.box.com/blob/main/content/guides/foo.md'
source_url: https://github.com/box/developer.box.com/blob/main/content/guides/foo.md
---
<Header to='/guides' centered >

Expand Down
Loading
Loading