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

chore: Fixup official project naming #79

Merged
merged 4 commits into from
Aug 26, 2020
Merged
Show file tree
Hide file tree
Changes from 2 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 .github/AUTOMATION_README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Github Actions and Integration

This directory is used to hold all templates and github actions that are integrated into the AWS RFDK Github Repository.
This directory is used to hold all templates and github actions that are integrated into the RFDK Github Repository.

## Pull Request Template

Expand Down
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to the AWS Render Farm Deployment Kit (AWS RFDK)
# Contributing to the Render Farm Deployment Kit on AWS (RFDK)

Thanks for your interest in contributing to the AWS RFDK! ❤️
Thanks for your interest in contributing to the RFDK! ❤️

This document describes how to set up a development environment and submit your contributions. Please read it carefully
and let us know if it's not up-to-date (even better, submit a PR with your corrections ;-)).
Expand All @@ -24,7 +24,7 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr

## Prerequisites

The AWS RFDK is written in Typescript and converted, using [jsii](https://github.com/aws/jsii), into Python. Thus, the
The RFDK is written in Typescript and converted, using [jsii](https://github.com/aws/jsii), into Python. Thus, the
minimal development environment must include:

- Node.js >= 10.21.0
Expand Down Expand Up @@ -100,7 +100,7 @@ To build, we use the [jsii/superchain docker container](https://hub.docker.com/r
>>> bash-4.2$
./pack.sh

# To build & test your changes to the AWS RFDK package
# To build & test your changes to the RFDK package
# Note: Must have done at least one run of ./build.sh to build the build tools.
>>> bash-4.2$
cd packages/aws-rfdk
Expand Down Expand Up @@ -128,16 +128,16 @@ One can use the `postinstall` script to symlink this repo. For example:
This assumes this repo is a sibling of the target repo and will install the CDK as a linked dependency during
__yarn install__.

#### Option 2 -- Use npm/pip to install the AWS RFDK packages into your environment
#### Option 2 -- Use npm/pip to install the RFDK packages into your environment

The packages that are created by the `./pack.sh` script can be installed directly into an npm or Python environment.

```bash
# Installing into a local npm environment
npm install <AWS RFDK directory>/dist/js/aws-rfdk@0.15.0.jsii.tgz
npm install <RFDK directory>/dist/js/aws-rfdk@0.15.0.jsii.tgz

# Installing into a Python environment
pip install --force <AWS RFDK directory>/dist/python/aws-rfdk-0.15.0.tar.gz
pip install --force <RFDK directory>/dist/python/aws-rfdk-0.15.0.tar.gz
```

### Cleaning up stale build artifacts
Expand Down
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
AWS Render Farm Deployment Kit (AWS RFDK)
Render Farm Deployment Kit on AWS (RFDK)
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS Render Farm Deployment Kit (AWS RFDK)
# Render Farm Deployment Kit on AWS (RFDK)

The AWS Render Farm Deployment Kit is an open-source library for use with the
The Render Farm Deployment Kit on AWS is an open-source library for use with the
[AWS Cloud Development Kit](https://github.com/aws/aws-cdk) that is designed to help you
deploy, configure, and maintain your render farm infrastructure in the cloud.

Expand Down Expand Up @@ -41,7 +41,7 @@ If you discover a potential security issue in this project we ask that you notif

## Contributing

Contributions to the AWS RFDK are encouraged. If you want to fix a problem, or want to enhance the library in any way, then
Contributions to the RFDK are encouraged. If you want to fix a problem, or want to enhance the library in any way, then
we are happy to accept your contribution. Information on contributing to the RFDK can be found
[in CONTRIBUTING.md](https://github.com/aws/aws-rfdk/blob/mainline/CONTRIBUTING.md).

Expand Down
2 changes: 1 addition & 1 deletion integ/NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
AWS Render Farm Deployment Kit (AWS RFDK)
Render Farm Deployment Kit on AWS (RFDK)
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2 changes: 1 addition & 1 deletion lambda-layers/NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
AWS Render Farm Deployment Kit (AWS RFDK)
Render Farm Deployment Kit on AWS (RFDK)
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2 changes: 1 addition & 1 deletion packages/aws-rfdk/NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
AWS Render Farm Deployment Kit (AWS RFDK)
Render Farm Deployment Kit on AWS (RFDK)
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
8 changes: 4 additions & 4 deletions packages/aws-rfdk/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS Render Farm Deployment Kit
# Render Farm Deployment Kit on AWS

The AWS Render Farm Deployment Kit (RFDK) is an open-source software development kit (SDK) that can be used to deploy, configure, and manage your render farm
The Render Farm Deployment Kit on AWS (RFDK) is an open-source software development kit (SDK) that can be used to deploy, configure, and manage your render farm
infrastructure in the cloud. The RFDK is built to operate with the AWS Cloud Development Kit (CDK) and provides a library of classes, called constructs, that each
deploy and configure a component of your cloud-based render farm. The current version of the RFDK supports render farms built using AWS Thinkbox Deadline
render management software, and provides the ability for you to easily go from nothing to a production-ready render farm in the cloud.
Expand All @@ -11,7 +11,7 @@ an object from the CDK and RFDK libraries represents the creation of a resource,
via AWS CloudFormation by the CDK toolkit. The parameters of an object’s creation control the configuration of the resource.

Please see the following sources for additional information:
* The [AWS RFDK Developer Guide](https://docs.aws.amazon.com/rfdk/latest/guide/what-is-rfdk.html)
* The [AWS RFDK API Documentation](https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk-construct-library.html)
* The [RFDK Developer Guide](https://docs.aws.amazon.com/rfdk/latest/guide/what-is-rfdk.html)
* The [RFDK API Documentation](https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk-construct-library.html)
* The [README for the main module](https://github.com/aws/aws-rfdk/blob/mainline/packages/aws-rfdk/lib/core/README.md)
* The [README for the Deadline module](https://github.com/aws/aws-rfdk/blob/mainline/packages/aws-rfdk/lib/deadline/README.md)
2 changes: 1 addition & 1 deletion packages/aws-rfdk/lib/deadline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ const ubl = new UsageBasedLicensing(stack, 'UsageBasedLicensing', {

### Usage-Based Licensing Docker Container Images

`UsageBasedLicensing` currently requires only one Docker container image for the Deadline License Forwarder. A License Forwarder image must satisfy the following criteria to be compatible with AWS RFDK:
`UsageBasedLicensing` currently requires only one Docker container image for the Deadline License Forwarder. A License Forwarder image must satisfy the following criteria to be compatible with RFDK:

- Deadline Client must be installed
- The default command must launch the License Forwarder
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-rfdk/lib/deadline/lib/database-connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ class DocDBDatabaseConnection extends DatabaseConnection {
if (docdbInstance) {
child.node.addDependency(docdbInstance);
} else if (this.props.database.node.defaultChild) {
throw new Error('The internal implementation of the AWS CDK\'s DocumentDB cluster construct may have changed. Please update to a newer AWS RFDK for an updated implementation, or file a ticket if this is the latest release.');
throw new Error('The internal implementation of the AWS CDK\'s DocumentDB cluster construct may have changed. Please update to a newer RFDK for an updated implementation, or file a ticket if this is the latest release.');
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions scripts/rfdk_build_environment.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
# Make sure we're running from the root of the CDK repo
if ! test -f package.json || ! grep '"name": "aws-rfdk-project",' package.json > /dev/null || ! grep '"private": true,' package.json > /dev/null
then
echo "Usage: Run from the root of the AWS RFDK repository"
echo "Usage: Run from the root of the RFDK repository"
exit 1
fi

echo "Entering jsii/superchain docker container so you can interactively build/test AWS RFDK."
echo "Entering jsii/superchain docker container so you can interactively build/test RFDK."

USER_OPT="-u $(id -u):$(id -g)"
USERFILE_MOUNTS="-v /etc/passwd:/etc/passwd:ro -v /etc/shadow:/etc/shadow:ro -v /etc/group:/etc/group:ro"
Expand Down
2 changes: 1 addition & 1 deletion tools/pkglint/lib/licensing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,6 @@ export const LICENSE =
`;

export const NOTICE =
`AWS Render Farm Deployment Kit (AWS RFDK)
`Render Farm Deployment Kit on AWS (RFDK)
Copyright 2018-${new Date().getFullYear()} Amazon.com, Inc. or its affiliates. All Rights Reserved.
`;