Skip to content

Remove rez bind --quickstart mention from docs. Resolves #1961 #1982

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Remove rez bind --quickstart mention from docs. Resolves #1961 #1982

wants to merge 5 commits into from

Conversation

@georgeantonopoulos
Copy link

@georgeantonopoulos georgeantonopoulos commented May 27, 2025

Changes Made

The PR contains three focused commits that systematically improve the documentation:

  1. Mark quickstart references for removal (f5c396b): Added TODO comments to identify all instances of --quickstart references that needed to be removed.

  2. Replace quickstart with individual commands (5e69b94):

  • Removed all references to rez-bind --quickstart
  • Replaced with individual rez-bind commands for essential packages (arch, os, platform)
  • Split package binding into two sections: "Essential packages" (safe to use) and "Optional packages" (less reliable)
  • Added appropriate warnings about potential issues with optional packages, especially on Windows
  1. Fix warning text formatting (f129b1e): Restored proper formatting and wording in the deprecation warning for rez-bind.

Resolves #1961

@georgeantonopoulos georgeantonopoulos requested a review from a team as a code owner May 27, 2025 10:09
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 27, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

georgeantonopoulos and others added 4 commits May 27, 2025 11:13
@georgeantonopoulos
all rez-bind --quickstart references marked for removal
17d9046 
Signed-off-by: George Antonopoulos <[email protected]>
@georgeantonopoulos
removed reference to --quistart, replaced with rez bind for all comma…
8882926 
…nds mentioned previously but split into safe and optional based on previous note.

Signed-off-by: George Antonopoulos <[email protected]>
@georgeantonopoulos
introducing back missing ref comment
43bccf2 
Signed-off-by: George Antonopoulos <[email protected]>
@georgeantonopoulos
docs: remove --quickstart from getting_started.rst
f979668 
      * drop all rez-bind --quickstart examples
      * add individual rez-bind commands
      * warn about Windows reliability issues

      Fixes AcademySoftwareFoundation#1961

Signed-off-by: George Antonopoulos <[email protected]>
@georgeantonopoulos georgeantonopoulos force-pushed the remove-rez-bind-quickstart-docs branch from 4a6a2f5 to f979668 Compare May 27, 2025 10:14
@georgeantonopoulos georgeantonopoulos mentioned this pull request May 29, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

remove rez-bind quickstart from docs

1 participant

@georgeantonopoulos