Skip to content

Commit

Permalink
Merge branch 'aces-2.0-reorg' into dev
Browse files Browse the repository at this point in the history
* aces-2.0-reorg:
  start of reoganization for ACES 2.0 system documentation
  • Loading branch information
aforsythe committed May 1, 2024
2 parents 2f28aa6 + 9f72b4a commit 729699f
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 4 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to ACES

We're thrilled that you're interested in contributing to ACES. To maintain the legal integrity of the project's codebase, we require all contributors to sign a Contributor License Agreement (CLA).

## Signing the CLA

- Before we can merge any of your contributions, you must sign our CLA.
- The process is simple. When you submit a pull request for the first time, you will be prompted to sign the CLA online.
- If you are contributing on behalf of your employer or if your contributions are owned by someone other than yourself (e.g., your employer), please make sure you have the right to submit the contributions under our project's CLA.

By signing the CLA, you assure the project and its users that your contributions do not infringe upon the rights of any third parties and that the project can use your contributions without legal repercussions.

If you have any questions about the CLA process, please feel free to contact a member of the ACES Team via ACESCentral.com.

## Requirement for Signed Commits

As part of our commitment to security and the integrity of our codebase, we require all commits to be signed. This helps us ensure that contributions are actually made by the account they come from and not altered by a third party.

### Why Signed Commits?

Signed commits provide an additional layer of security by guaranteeing that the commits are from a verified source. This is crucial for maintaining the trustworthiness of our codebase.

### How to Sign Commits

To sign commits, you'll need to use a GPG (GNU Privacy Guard) or S/MIME (Secure/Multipurpose Internet Mail Extensions) key. If you haven't already set up a GPG key, you can follow [GitHub's guide on generating a new GPG key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key).

Once you have a GPG key, you can add it to your GitHub account. For instructions on how to do this, see [GitHub's documentation on adding a new GPG key to your account](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account).

When you have your GPG key added to your GitHub account, you can start signing your commits. If you're using the command line, you can sign commits with `git commit -S -m "Your commit message"`.

### Verifying a Signed Commit

You can verify that your commits are signed by looking for the "Verified" label on GitHub's commit interface.

### What if You Cannot Sign Your Commits?

We understand that in some scenarios, you might not be able to sign commits. If you find yourself in this situation, please reach out to the project maintainers for assistance.

For more detailed instructions on signing commits, you can refer to [GitHub's documentation on signing commits](https://docs.github.com/en/github/authenticating-to-github/signing-commits).

---

We appreciate your contributions to ACES, and we thank you for adhering to our signed commits policy. This policy helps us maintain the security and integrity of our codebase.

If you have any questions about this process, please feel free to contact the project maintainers.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# License Terms for Academy Color Encoding System Components

Academy Color Encoding System (ACES) software and tools are provided by the Academy under the following terms and conditions: A worldwide, royalty-free, non-exclusive right to copy, modify, create derivatives, and use, in source and binary forms, is hereby granted, subject to acceptance of this license.

Copyright 2019 Academy of Motion Picture Arts and Sciences (A.M.P.A.S.). Portions contributed by others as indicated. All rights reserved.

Performance of any of the aforementioned acts indicates acceptance to be bound by the following terms and conditions:

> Copies of source code, in whole or in part, must retain the above copyright notice, this list of conditions and the Disclaimer of Warranty.
>
> Use in binary form must retain the above copyright notice, this list of conditions and the Disclaimer of Warranty in the documentation and/or other materials provided with the distribution.
>
> Nothing in this license shall be deemed to grant any rights to trademarks, copyrights, patents, trade secrets or any other intellectual property of A.M.P.A.S. or any contributors, except as expressly stated herein.
>
> Neither the name "A.M.P.A.S." nor the name of any other contributors to this software may be used to endorse or promote products derivative of or based on this software without express prior written permission of A.M.P.A.S. or the contributors, as appropriate.
This license shall be construed pursuant to the laws of the State of California, and any disputes related thereto shall be subject to the jurisdiction of the courts therein.

Disclaimer of Warranty: THIS SOFTWARE IS PROVIDED BY A.M.P.A.S. AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL A.M.P.A.S., OR ANY CONTRIBUTORS OR DISTRIBUTORS, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, RESITUTIONARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE ACADEMY SPECIFICALLY DISCLAIMS ANY REPRESENTATIONS OR WARRANTIES WHATSOEVER RELATED TO PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS IN THE ACADEMY COLOR ENCODING SYSTEM, OR APPLICATIONS THEREOF, HELD BY PARTIES OTHER THAN A.M.P.A.S.,WHETHER DISCLOSED OR UNDISCLOSED.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
## ACES Documentation ##
## ACES Documentation

As of early 2022, ACES documentation (ACES specifications, technical bulletins, procedures, and guides) has been migrated to an online documentation system, available at [docs.acescentral.com](docs.acescentral.com).
This repository contains the code used to generate the ACES documentation website hosted at [https://docs.acescentral.com](https://docs.acescentral.com).

The docs at the above link should be considered the most up-to-date. Prior to this online documentation system, PDFs were rendered from LaTeX source. For now, the LaTeX source will remain available in this repository but will eventually be removed once full migration to the mkdocs system is complete.
The docs at the above link should be considered the most up-to-date. Prior to this online documentation system, PDFs were rendered from LaTeX source. The LaTeX source remains available in the history of this repository but should be considered out of date unless explictly linked to by this website.

## License
This project is licensed under the terms of the [LICENSE](./LICENSE.md) agreement.

## Contributing
Thank you for your interest in contributing to our project. Before any contributions can be accepted, we require contributors to sign a Contributor License Agreement (CLA) to ensure that the project can freely use your contributions. You can find more details and instructions on how to sign the CLA in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.

The ACES Docs website is built using `mkdocs` with the `Material for Mkdocs` theme, generating the HTML version from Markdown text files. The site configuration, including navigation, is managed through the `mkdocs.yml` file.

To update existing content, simply modify the relevant `.md` file. For new pages, create a `.md` file and add a reference to it in the `nav:` section of the `mkdocs.yml`. Changes are automatically deployed through a [GitHub Action](.github/workflows/main.yml) when commits are made to either the `main` or `dev` branches. Updates on `main` appear on [https://docs.acescentral.com](https://docs.acescentral.com), while `dev` branch updates appear on [https://draftdocs.acescentral.com](https://draftdocs.acescentral.com).

Before submitting a pull request, preview your changes locally using the included `Dockerfile`. Ensure Docker is installed, navigate to the repository directory in your terminal, and execute `docker compose up`. Your changes will be viewable at [http://0.0.0.0:8000](http://0.0.0.0:8000).

Once satisfied with your updates, proceed to submit a pull request.

## Support
For support, please visit [ACESCentral.com](https://acescentral.com)
3 changes: 3 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Support

For support, please visit [ACESCentral.com](https://acescentral.com)
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ theme:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
icon: material/lightbulb-auto-outline
name: Switch to light mode

# Palette toggle for light mode
Expand Down

0 comments on commit 729699f

Please sign in to comment.