move cuspatial, cuproj docs under 'inactive projects' #654
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,3 +29,7 @@ select the docs that fit your needs. | |
| ## RAPIDS Libraries | ||
|
|
||
| {% include api-docs.html data=site.data.docs.libs %} | ||
|
|
||
| ## Inactive Projects | ||
|
|
||
| {% include api-docs.html data=site.data.docs.inactive-projects %} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -64,9 +64,15 @@ aws_cp() { | |
| } | ||
|
|
||
| # Downloads the RAPIDS libraries' documentation files from S3 and places them | ||
| # into the "_site/api" folder. | ||
| # | ||
| # The libraries that should be copied are read from "_data/docs.yml". | ||
| # | ||
| # The versions that should be copied are read from a mix of sources: | ||
| # | ||
| # - active projects: "_data/releases.json" | ||
| # - inactive projects: 'version-overrides' field in entries in "_data/docs.yml" | ||
| # | ||
| download_lib_docs() { | ||
| local DST PROJECT PROJECT_MAP \ | ||
| SRC VERSION_MAP VERSION_NAME \ | ||
|
|
@@ -78,10 +84,11 @@ download_lib_docs() { | |
| "nightly": { "version": .nightly.version, "ucxx_version": .nightly.ucxx_version } | ||
| }' _data/releases.json) | ||
|
|
||
| echo "--- processing active RAPIDS libraries ---" | ||
| PROJECT_MAP=$(yq '.apis + .libs' _data/docs.yml) | ||
|
|
||
| for PROJECT in $(yq -r 'keys | .[]' <<< "$PROJECT_MAP"); do | ||
| for VERSION_NAME in $(jq -r 'keys | .[]' <<< "$VERSION_MAP"); do | ||
|
Member
Author
There was a problem hiding this comment. Switching the order of these so that in the logs, all the updates are grouped by library. I personally think it's more common to look at these logs with a question like "which files were copied for Happy to switch this back if reviewers disagree, I don't feel strongly. |
||
| VERSION_NUMBER=$(jq -r --arg vn "$VERSION_NAME" --arg pr "$PROJECT" ' | ||
| if ($pr | contains("ucxx")) then | ||
| .[$vn].ucxx_version | ||
|
|
@@ -97,7 +104,35 @@ download_lib_docs() { | |
|
|
||
| SRC="s3://${DOCS_BUCKET}/${PROJECT}/html/${VERSION_NUMBER}/" | ||
| DST="$(yq -n 'env(GENERATED_DIRS)|.libs')/${PROJECT}/${VERSION_NUMBER}/" | ||
| aws_cp "${SRC}" "${DST}" | ||
| done | ||
| done | ||
|
|
||
| # inactive projects (no longer maintained, but we still host the docs) | ||
| echo "--- processing inactive projects ---" | ||
| INACTIVE_PROJECT_MAP=$(yq '.inactive-projects' _data/docs.yml) | ||
|
|
||
| for PROJECT in $(yq -r 'keys | .[]' <<< "$INACTIVE_PROJECT_MAP"); do | ||
| for VERSION_NAME in $(jq -r 'keys | .[]' <<< "$VERSION_MAP"); do | ||
| # do not attempt updates for any versions where the corresponding key is '0' in docs.yml | ||
| INACTIVE_PROJECT_MAP_JSON=$(yq -r -o json '.' <<< "$INACTIVE_PROJECT_MAP") | ||
| if [ "$(jq -r --arg pr "$PROJECT" --arg vn "$VERSION_NAME" '.[$pr].versions[$vn]' <<< "$INACTIVE_PROJECT_MAP_JSON")" == "0" ]; then | ||
| echo "Skipping: $PROJECT | $VERSION_NAME" | ||
| continue | ||
| fi | ||
|
|
||
| # get the version from the 'version-overrides' field in docs.yml, hard-coded there | ||
| # so it doesn't change from release-to-release for inactive projects | ||
| VERSION_NUMBER=$( | ||
| jq -r \ | ||
| --arg vn "$VERSION_NAME" \ | ||
| --arg pr "${PROJECT}" \ | ||
| '.[$pr]."version-overrides"[$vn]' \ | ||
| <<< "${INACTIVE_PROJECT_MAP_JSON}" | ||
| ) | ||
|
|
||
| SRC="s3://${DOCS_BUCKET}/${PROJECT}/html/${VERSION_NUMBER}/" | ||
| DST="$(yq -n 'env(GENERATED_DIRS)|.libs')/${PROJECT}/${VERSION_NUMBER}/" | ||
| aws_cp "${SRC}" "${DST}" | ||
| done | ||
| done | ||
|
|
@@ -108,6 +143,7 @@ download_lib_docs() { | |
| download_deployment_docs() { | ||
| local DST SRC VERSION | ||
|
|
||
| echo "--- processing deployment docs ---" | ||
| for VERSION in nightly stable; do | ||
| SRC="s3://${DOCS_BUCKET}/deployment/html/${VERSION}/" | ||
| DST="$(yq -n 'env(GENERATED_DIRS)|.deployment')/${VERSION}/" | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These 2 lines are the only new logic. Basically, "if the entry in
_data/docs.ymlexplicitly specifies versions, just use those directly instead of looking up versions in the data from_data/releases.json".The rest of the diff here is just expanding this out to multiple lines with indentation, to make it easier to read. This doesn't introduce any visual artifacts like weird spacing or line breaks because I've also introduced a lot more whitespace stripping, via
{%-and-%}.For details on how that works in Liquid, see https://shopify.github.io/liquid/basics/whitespace/