This project contain the markdown source for all release notes for Box Platform, including the APIs, SDKs, UI elements, and CLI.
Visit developer.box.com/changelog
to see the latest changes in Box
Platform.
To edit any of the existing release notes, please have a look at the
./content
folder.
Please follow the contribution guidelines when contributing to the source of this project.
- Installation & setup
- Notes for Box employees
- The project structure
- Adding a new release note
- Contributing a pull request
- Markdown style guide
The quickest way to start adding a new release note is to use the build in templates and generator.
git clone [email protected]:box/box-developer-changelog.git box-developer-changelog
cd box-developer-changelog
yarn install
cp .env.example .env
yarn new
The yarn new
command will take you through a set of questions and will then
create a new entry based on the standard template. A
short template is also available when working with more
complex changes.
This project has been set up to automatically pull in new release notes from the Box CLI, Java, Windows, and .NET SDKs, and UI elements.
When a new GitHub release is created for one of these repositories, a GitHub Action will send a notification to this repository which will trigger off another GitHub action in this project that pulls in the content and opens a new Pull Request.
Once the pull request is created, another process will kick off to test and lint
the new content and automatically merge the pull request. This new content will
then be compiled and pushed to the en
branch, where it will be picked up by
Netlify to be combined with all other developer content and pushed to
developer.box.com
.
The content in this repository is automatically translated to Japanese by our
in-house translation team. Once a day a snapshot will be made from the en
to
the en-snapshot
branch. Then, once translated, the new Japanese content is
pushed to the jp
branch where it is picked up by Netlify and combined with all
other translated content and pushed to
ja.developer.box.com
.
Copyright 2020 Box, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.