Add package orderers documentation #1737
Conversation
Signed-off-by: BryceGattis <[email protected]>
Signed-off-by: BryceGattis <[email protected]>
There was a problem hiding this comment.
It's a good start. I made small comments that shouldn't be too difficult to address.
We should also be careful to not drop or have duplicated information with https://rez--1737.org.readthedocs.build/en/1737/configuring_rez.html#package_orderers.
docs/source/package_orderers.rst
Outdated
| Package Orderers | ||
| ================ | ||
|
|
||
| Rez's default version resolution algorithm will always sort by the latest alphanumeric |
There was a problem hiding this comment.
Should we reference https://rez.readthedocs.io/en/stable/basic_concepts.html#versions? I would also like to keep some parts of https://rez--1737.org.readthedocs.build/en/1737/configuring_rez.html#package_orderers if possible.
There was a problem hiding this comment.
@JeanChristopheMorinPerso I added the cross reference to https://rez.readthedocs.io/en/stable/basic_concepts.html#versions.
What do you mean you'd like to keep some parts of https://rez--1737.org.readthedocs.build/en/1737/configuring_rez.html#package_orderers. Can you be more specific?
|
|
||
| Configuring package orderers | ||
| ============================ |
There was a problem hiding this comment.
| Configuring package orderers | |
| ============================ |
I don't think we need a section for configuring.
There was a problem hiding this comment.
@JeanChristopheMorinPerso Do you mean we don't need this section because it already exists on the Configuring Rez page? I'm not really adding new content here, just cross referencing to that page.
| } | ||
| ] | ||
|
|
||
| Per Family Order |
There was a problem hiding this comment.
I think I would move this to the end if we are to mention version_split.
There was a problem hiding this comment.
@JeanChristopheMorinPerso Can do, but why is this? I'm still trying to wrap my head around the architecture of this code.
| Per Family Order | ||
| ---------------- | ||
|
|
||
| This orderer allows you to define different orderers to different package families. |
There was a problem hiding this comment.
We should document that orderers can be any supported orderer.
There was a problem hiding this comment.
@JeanChristopheMorinPerso Can you explain a bit more what you mean?
Co-authored-by: Jean-Christophe Morin <[email protected]> Signed-off-by: Bryce Gattis <[email protected]>
Signed-off-by: BryceGattis <[email protected]>
…om/BryceGattis/rez into add_package_orderers_documentation
Looking for some feedback on what exactly this page should look like. Some examples of the configuration are on the configuring rez page, but I'm not sure if we want the same kind of info here or not.
TODO: