Update documentation for 2.2 release (#1738)

* Update documentation for 2.2 release Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Fix typos Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Remove V2_DOC_README.md Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Tweaks to 2.2 Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Improve installation section Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Add link to demo config Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Fix typos Signed-off-by: Doug Walker <doug.walker@autodesk.com> * Improve file_rules section Signed-off-by: Doug Walker <doug.walker@autodesk.com> Signed-off-by: Doug Walker <doug.walker@autodesk.com>
AcademySoftwareFoundation · Jan 4, 2023 · 17f5c98 · 17f5c98
1 parent 5152635
commit 17f5c98
Show file tree

Hide file tree

Showing 31 changed files with 1,259 additions and 412 deletions.
diff --git a/COMMITTERS.md b/COMMITTERS.md
@@ -20,3 +20,4 @@ The current OpenColorIO Committers are:
 | Doug Walker | @doug-walker |
 | Kevin Wheatley | @KevinJW |
 | Rémi Achard | @remia |
+| Cédrik Fuoco | @cedrik-fuoco-adsk |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,7 +19,7 @@ explains our contribution process and procedures, so please review it first:
 For a description of the roles and responsibilities of the various
 members of the OpenColorIO community, see [GOVERNANCE](GOVERNANCE.md), and
 for further details, see the project's
-[Technical Charter](docs/aswf/Charter.md). Briefly, Contributors are anyone
+[Technical Charter](ASWF/Charter.md). Briefly, Contributors are anyone
 who submits content to the project, Committers review and approve such
 submissions, and the Technical Steering Committee provides general project
 oversight.
@@ -214,18 +214,20 @@ the work.
 a Committer other than the PR contributor may squash and merge changes into the 
 main branch.
 
-See also (from the OCIO Developer Guide):
-* [Getting started](http://opencolorio.org/developers/getting_started.html)
-* [Submitting Changes](http://opencolorio.org/developers/submitting_changes.html)
+For a more detailed description of the contribution process, please see the 
+Contributing Guide in the main OCIO documentation:
+
+* [Getting Started](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#getting-started)
+* [Submitting Changes](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#submitting-changes)
 
 ## Coding Standards
 
 Please see the OpenColorIO
-[Coding guidelines](http://opencolorio.org/developers/coding_guidelines.html)
+[Coding guidelines](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#coding-style-guide)
 for a reference on project code style and best practices.
 
 For standards on contributing to documentation, see the
-[Documentation guidelines](http://opencolorio.org/developers/documentation_guidelines.html).
+[Documentation guidelines](https://opencolorio.readthedocs.io/en/latest/guides/contributing/contributing.html#documentation-guidelines).
 
 ## Test Policy
 
@@ -245,27 +247,8 @@ The test should should be run, via ``ctest``, before submitting a pull request.
 
 ## Versioning Policy
 
-OpenColorIO uses [semantic versioning](https://semver.org), which labels each
-version with three numbers: Major.Minor.Patch, where:
-
-* **MAJOR** indicates incompatible API changes
-* **MINOR** indicates functionality added in a backwards-compatible manner
-* **PATCH** indicates backwards-compatible bug fixes
-
-## Creating a Release
-
-To create a new release from the main branch:
-
-1. Update the release notes in ``CHANGELOG.md`` with a high-level summary of
-   the features and improvements. Also include the summary in the Release
-   comments.
-
-2. Create a new release on the GitHub Releases page.
-
-3. Tag the release with name beginning with '``v``', e.g. '``v2.1.0``'.
-
-4. Download and sign the release tarball, as described
-   [here](https://wiki.debian.org/Creating%20signed%20GitHub%20releases),
+OpenColorIO labels each version with three numbers: Major.Minor.Patch, where:
 
-5. Attach the detached ``.asc`` signature file to the GitHub release as a
-   binary file.
+* **MAJOR** indicates major architectural changes
+* **MINOR** indicates an introduction of significant new features
+* **PATCH** indicates ABI-compatible bug fixes and minor enhancements
diff --git a/docs/V2_DOC_README.md b/docs/V2_DOC_README.md
diff --git a/docs/concepts/publications/publications.rst b/docs/concepts/publications/publications.rst
@@ -4,11 +4,28 @@
 
 .. _publications:
 
-Publications
-============
+Presentations & Publications
+============================
 
-DigiPro 2020 **paper** `"The ASWF takes OpenColorIO to the Next Level" <https://drive.google.com/file/d/1y_0ZEftivHH0zoKwvKZx3gH_u_cDm1bD/view?usp=sharing>`_
+* OCIO wins the Pipeline Tool award at DigiPro 2022! `video <https://vimeo.com/742052701>`_
 
-DigiPro 2020 **video** `"The ASWF takes OpenColorIO to the Next Level" <https://vimeo.com/458011669>`_
+* ASWF Open Source Days 2022 `video <https://www.youtube.com/watch?v=WzFlz1HeNdI>`_
 
-`Cinematic Color <http://cinematiccolor.org/>`_
+* HPA Tech Retreat 2022 "Color Processing with OCIO v2 and the Academy/ASC Common LUT Format"
+  `Slides & Tutorial <https://drive.google.com/drive/folders/1ZRTIYE6kFb-7sTUtYIYFNJndhY6tmJee?usp=share_link>`_
+
+* OCIO v2 wins an Engineering Excellence award from the Hollywood Post Alliance! 
+  `article <https://www.hollywoodreporter.com/movies/movie-news/hpa-engineering-excellence-award-recipients-announced-1234995410/>`_
+
+* SIGGRAPH 2021 course "Color management with OpenColorIO V2" 
+  `video <https://vimeo.com/689093714>`__  `PDF <https://drive.google.com/file/d/1v37Bz7s1wbJNg-ULsBqnGPA9h7pWNfhU/view?usp=share_link>`__  `ACM <https://dl.acm.org/doi/10.1145/3450508.3464600>`_
+
+* ASWF Open Source Days 2021 `video <https://youtu.be/FSzLwSTJjWo>`_
+
+* DigiPro 2020 "The ASWF takes OpenColorIO to the Next Level" `video <https://vimeo.com/458011669>`__  `PDF <https://drive.google.com/file/d/1y_0ZEftivHH0zoKwvKZx3gH_u_cDm1bD/view?usp=sharing>`__  `ACM <https://dl.acm.org/doi/abs/10.1145/3403736.3403942>`_
+
+* ASWF Open Source Days 2020 `video <https://www.youtube.com/watch?v=7e0SSka8Ar8>`_
+
+* ASWF Open Source Days 2019 `video <https://youtu.be/L5dpFtgZuhQ>`_
+
+* `Cinematic Color <http://cinematiccolor.org/>`_
diff --git a/docs/configurations/_index.rst b/docs/configurations/_index.rst
@@ -10,8 +10,10 @@ Configurations
 .. toctree::
    :caption: Configurations
 
+   aces_studio
+   aces_cg
+   ocio_v2_demo
    aces_1.0.3
-   nuke_default
    spi_anim
    spi_vfx
-   ocio_v2_demo
+   nuke_default
diff --git a/docs/configurations/aces_1.0.3.rst b/docs/configurations/aces_1.0.3.rst
@@ -2,17 +2,21 @@
   SPDX-License-Identifier: CC-BY-4.0
   Copyright Contributors to the OpenColorIO Project.
 
+.. _aces_1.0.3:
+
 aces_1.0.3
 ==========
 
 This section describes the ACES 1.0.3 OpenColorIO configuration.
 
 .. note::
-    There is a more recent version of the ACES config for ACES 1.2 available here:
+    There is a more recent version of the ACES 1.0.3 config for ACES 1.2 available here:
 
     - https://github.com/colour-science/OpenColorIO-Configs/tree/feature/aces-1.2-config
 
-    An ACES config that takes advantage of the new OCIO v2 features is under development.
+.. note::
+    Please note that both of these configurations have been supplanted by the new 
+    :ref:`aces_studio` for OCIO v2.
 
 
 Information about ACES

diff --git a/docs/configurations/aces_cg.rst b/docs/configurations/aces_cg.rst
@@ -0,0 +1,42 @@
+..
+  SPDX-License-Identifier: CC-BY-4.0
+  Copyright Contributors to the OpenColorIO Project.
+
+.. _aces_cg:
+
+ACES CG Config
+==============
+
+The ACES Computer Graphics (CG) config is a simple, lightweight config intended for use
+in typical digital content creation (DCC) apps that need robust choices for texture and
+rendering spaces and a basic selection of display and view transforms.
+
+Users who need a more extensive set of color spaces, including digital cinema camera
+color spaces and a wider set of displays and view should look at the :ref:`aces_studio`.
+
+The latest version of this config may be downloaded from the Releases page of its GitHub
+`repo. <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/releases>`_
+
+The ACES CG Config leverages the high quality ACES implementation built into OCIO itself
+and so requires no external LUT files.  In fact, even the config file is built into OCIO
+and users may access it from any application that uses OCIO 2.2 or higher by using the
+following string in place of the config path::
+    ocio://cg-config-v1.0.0_aces-v1.3_ocio-v2.1
+
+The default built-in config is currently the ACES CG Config, so the even simpler:
+``ocio://default`` may be used instead.  Note however, that the value of the default
+config may evolve over time.
+
+The OCIO Configs Working Group collected input from the community and simplified the
+naming scheme relative to the earlier OCIO v1 ACES configs.  However, aliases have been 
+added so that the original color space names continue to work (if there is an equivalent
+space in the new config).
+
+Please note that with OCIO v2 we are trying to be more rigorous about what constitutes a 
+"color space". For this reason, the new configs do not bake view transforms or looks into 
+the display color spaces.  Therefore, it is necessary to use a DisplayViewTransform rather 
+than a ColorSpaceTransform if you want to bake in an ACES Output Transform.  This is not 
+only more rigorous from a color management point of view, it also helps clarify to end-users 
+the important role of a view transform in the process.  Baking in a view transform is a 
+fundamentally different process than just converting between color space encodings, and it 
+should be perceived as such by users.
diff --git a/docs/configurations/aces_studio.rst b/docs/configurations/aces_studio.rst
@@ -0,0 +1,41 @@
+..
+  SPDX-License-Identifier: CC-BY-4.0
+  Copyright Contributors to the OpenColorIO Project.
+
+.. _aces_studio:
+
+ACES Studio Config
+==================
+
+The ACES Studio Config is the successor to the widely used :ref:`ACES config <aces_1.0.3>`
+for OCIO v1.
+
+It contains the complete set of ACES color spaces, displays, and views.  In addition, it
+contains some extra color spaces that are widely used in the VFX and post-production 
+industries.
+
+Users who need a simpler config that contains just the basics needed to use ACES color
+management in common DCC tools are encouraged to check out the :ref:`aces_cg`.
+
+The latest version of this config may be downloaded from the Releases page of its GitHub
+`repo. <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/releases>`_
+
+The ACES Studio Config leverages the high quality ACES implementation built into OCIO itself
+and so requires no external LUT files.  In fact, even the config file is built into OCIO
+and users may access it from any application that uses OCIO 2.2 or higher by using the
+following string in place of the config path::
+    ocio://studio-config-v1.0.0_aces-v1.3_ocio-v2.1
+
+The OCIO Configs Working Group collected input from the community and simplified the
+naming scheme relative to the earlier OCIO v1 ACES configs.  However, aliases have been 
+added so that the original color space names continue to work (if there is an equivalent
+space in the new config).
+
+Please note that with OCIO v2 we are trying to be more rigorous about what constitutes a 
+"color space". For this reason, the new configs do not bake view transforms or looks into 
+the display color spaces.  Therefore, it is necessary to use a DisplayViewTransform rather 
+than a ColorSpaceTransform if you want to bake in an ACES Output Transform.  This is not 
+only more rigorous from a color management point of view, it also helps clarify to end-users 
+the important role of a view transform in the process.  Baking in a view transform is a 
+fundamentally different process than just converting between color space encodings, and it 
+should be perceived as such by users.
diff --git a/docs/configurations/ocio_v2_demo.rst b/docs/configurations/ocio_v2_demo.rst
@@ -10,6 +10,10 @@ ocio-v2_demo
 Note: this is not intended to be a complete production-ready config, its purpose
 is to introduce many of the new features in OCIO v2.
 
+Due to the limitations of the web template, it may be easier for you to read this
+config in a text editor.  The config file is located 
+`here. <https://github.com/AcademySoftwareFoundation/OpenColorIO/tree/main/docs/configurations/ocio-v2_demo.ocio>`_ 
+
 
 .. literalinclude:: ocio-v2_demo.ocio
    :language: yaml