Skip to content

Commit 6a5c866

Browse files
authored
docs: Update some URLs to our new vanity URLs (#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 <lg@larrygritz.com>
1 parent 541e870 commit 6a5c866

File tree

3 files changed

+28
-14
lines changed

3 files changed

+28
-14
lines changed

GOVERNANCE.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,24 @@ guidance.
2020
The OSL project grows and thrives from assistance from Contributors.
2121
Contributors include anyone in the community who contributes code,
2222
documentation, or other technical artifacts that have been incorporated into
23-
the projects repository.
23+
the project repository.
2424

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

2828
### How to Become a Contributor
2929

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

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

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

3942
## Committers
4043

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

7679
## Technical Steering Committee
7780

78-
The Technical Steering Committee (TSC) has final authority over this
79-
project. As defined in the project charter, TSC responsibilities include,
80-
but are not limited to:
81+
The Technical Steering Committee (TSC) has final authority over this project.
82+
As defined in the project charter, in addition to committer activities, TSC
83+
responsibilities also include, but are not limited to:
8184

8285
* Coordinating technical direction of the Project.
8386

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

185+
The biweekly TSC meetings can be found on the [ASWF Calendar](https://calendar.openshadinglanguage.org),
186+
just click on the OSL TSC meeting entries to get the Zoom link.
187+
182188
Items are added to the TSC agenda which are considered contentious or are
183189
modifications of governance, contribution policy, TSC membership, or release
184190
process, in addition to topics involving the high-level technical direction
@@ -206,5 +212,6 @@ archived in the project repository.
206212

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

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ The OSL language specification can be found at
458458
distribution) or in the share/doc/OSL/osl-languagespec.pdf file of an
459459
installed binary distribution.
460460

461-
[Experimental OSL Documentation on ReadTheDocs](https://open-shading-language.readthedocs.io/)
461+
[OSL Documentation on ReadTheDocs](https://docs.openshadinglanguage.org)
462462
This will be the future documentation. It's probably as complete as the PDF,
463463
but it needs some proofreading, so the PDF is still considered the
464464
authoritative source for now. But some time soon, the old PDF specification

doc/RELEASING.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,15 @@ Odds and ends to do after the tag is pushed and the announcements are sent:
334334
- Re-read RELEASING.md and ensure that the instructions match what you
335335
have done. Update as necessary.
336336

337-
- For annual beta releases, post a short message to the "Open Shading
338-
Language" channel of the ASWF slack. It can be a one-line announcement and
339-
then just a link to the GitHub release page for this version.
340-
337+
- Go to [OSL's docs hosted on readthedocs.org](https://docs.openshadinglanguage.org),
338+
and ensure that the new release is built, visible, and is the default
339+
release shown (specified in the Admin section). I tend to keep the latest
340+
patch of each minor release available for reference indefinitely, but hide
341+
the docs for earlier patch releases within that minor release series.
342+
343+
- Edit the top-level CMakeList.txt to update the version to the *next*
344+
anticipated release on the branch, in order to ensure that anybody building
345+
from subsequent patches won't get a release number that advertises itself
346+
incorrectly as a prior tagged release. Also edit CHANGES.md to add a new
347+
(blank) heading for the next patch or release.
341348

0 commit comments

Comments
 (0)