Skip to content

Commit

Permalink
docs: Update some URLs to our new vanity URLs (AcademySoftwareFoundat…
Browse files Browse the repository at this point in the history
…ion#1902)

Also a little be of typo fixing and docs updating, mostly from
comparing to the same docs in OIIO and picking the more thorough
description.

Signed-off-by: Larry Gritz <[email protected]>
  • Loading branch information
lgritz authored Dec 4, 2024
1 parent 541e870 commit 6a5c866
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 14 deletions.
25 changes: 16 additions & 9 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,24 @@ guidance.
The OSL project grows and thrives from assistance from Contributors.
Contributors include anyone in the community who contributes code,
documentation, or other technical artifacts that have been incorporated into
the projects repository.
the project repository.

Anyone can be a Contributor. You need no formal approval from the project,
beyond the legal forms.

### How to Become a Contributor

* Review the coding standards to ensure your contribution is in line
with the project's coding and styling guidelines.
* Review the coding standards and [contributing guidelines](CONTRIBUTING.md)
to ensure your contribution is in line with the project's coding and styling
guidelines.

* Sign the Individual CLA, or if you are employed by an organization that
might have any claim to IP you create, have your organization sign the
Corporate CLA.

* Submit your code as a PR with the appropriate DCO sign-off.
* Submit your code as a PR with the appropriate DCO sign-off on each commit.
The easiest way to do this is to ensure that you commit your code with `git
commit -s`.

## Committers

Expand Down Expand Up @@ -75,9 +78,9 @@ request that the TSC restore them to active Committer status.

## Technical Steering Committee

The Technical Steering Committee (TSC) has final authority over this
project. As defined in the project charter, TSC responsibilities include,
but are not limited to:
The Technical Steering Committee (TSC) has final authority over this project.
As defined in the project charter, in addition to committer activities, TSC
responsibilities also include, but are not limited to:

* Coordinating technical direction of the Project.

Expand Down Expand Up @@ -136,7 +139,7 @@ Current voting members of the TSC are:
* Nicolas Guiard - Isotropix
* Clint Hanson - DNEG
* Adrien Herubel - Autodesk
* Lee Kerley - Sony Pictures Imageworks
* Lee Kerley - Apple
* Mitch Prater - Laika
* Brecht Van Lommel - Blender
* Alex Wells - Intel
Expand Down Expand Up @@ -179,6 +182,9 @@ her absence. Meetings may also be streamed online where appropriate;
connection details will be posted to the osl-dev mail list in advance of the
scheduled meeting.

The biweekly TSC meetings can be found on the [ASWF Calendar](https://calendar.openshadinglanguage.org),
just click on the OSL TSC meeting entries to get the Zoom link.

Items are added to the TSC agenda which are considered contentious or are
modifications of governance, contribution policy, TSC membership, or release
process, in addition to topics involving the high-level technical direction
Expand Down Expand Up @@ -206,5 +212,6 @@ archived in the project repository.

Due to the challenges of scheduling a global meeting with participants in
several time zones, the TSC will seek to resolve as many agenda items as
possible outside of meetings on the public mailing list.
possible outside of meetings on the public mailing list or through GitHub
issues, discussions, and pull requests.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ The OSL language specification can be found at
distribution) or in the share/doc/OSL/osl-languagespec.pdf file of an
installed binary distribution.

[Experimental OSL Documentation on ReadTheDocs](https://open-shading-language.readthedocs.io/)
[OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)
This will be the future documentation. It's probably as complete as the PDF,
but it needs some proofreading, so the PDF is still considered the
authoritative source for now. But some time soon, the old PDF specification
Expand Down
15 changes: 11 additions & 4 deletions doc/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,8 +334,15 @@ Odds and ends to do after the tag is pushed and the announcements are sent:
- Re-read RELEASING.md and ensure that the instructions match what you
have done. Update as necessary.

- For annual beta releases, post a short message to the "Open Shading
Language" channel of the ASWF slack. It can be a one-line announcement and
then just a link to the GitHub release page for this version.

- Go to [OSL's docs hosted on readthedocs.org](https://docs.openshadinglanguage.org),
and ensure that the new release is built, visible, and is the default
release shown (specified in the Admin section). I tend to keep the latest
patch of each minor release available for reference indefinitely, but hide
the docs for earlier patch releases within that minor release series.

- Edit the top-level CMakeList.txt to update the version to the *next*
anticipated release on the branch, in order to ensure that anybody building
from subsequent patches won't get a release number that advertises itself
incorrectly as a prior tagged release. Also edit CHANGES.md to add a new
(blank) heading for the next patch or release.

0 comments on commit 6a5c866

Please sign in to comment.