Skip to content
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.

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

Eliminate Manual Copy Steps for Making Documentation Live #67

Open
kfeinauer opened this issue Jun 7, 2022 · 0 comments
Open

Eliminate Manual Copy Steps for Making Documentation Live #67

kfeinauer opened this issue Jun 7, 2022 · 0 comments
Labels
launcher Related to the launcher

Comments

@kfeinauer
Copy link
Contributor

When releasing a new version of the SDK, the documentation is uploaded to the following places:

// copy documentation to s3
sh "aws s3 sync docs/ApiRefHtml s3://docs.rstudio.com/rlps/apiref/${version}/"
sh "aws s3 sync docs/ApiRefHtml s3://docs.rstudio.com/rlps/apiref/latest/"
sh "aws s3 sync docs/QuickStartHtml s3://docs.rstudio.com/rlps/quickstart/${version}/"
sh "aws s3 sync docs/QuickStartHtml s3://docs.rstudio.com/rlps/quickstart/latest/"
sh "aws s3 sync docs/DevGuideHtml s3://docs.rstudio.com/rlps/devguide/${version}/"
sh "aws s3 sync docs/DevGuideHtml s3://docs.rstudio.com/rlps/devguide/latest/"

However, our official documentation points to the root of the buckets, as seen in the path here: https://docs.rstudio.com/rlps/quickstart/. Note that it points to the root of the quickstart bucket, not quickstart/latest. This is linked to here: https://www.rstudio.com/products/launcher-plugin-sdk/

We should either adjust the release steps to automatically copy to the root of the bucket as well, or adjust the links to point to the /latest path. We only want this to happen when we make the new version of the SDK live, so this might necessitate a new release pipeline.

@bschwedler bschwedler added the launcher Related to the launcher label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
launcher Related to the launcher
Projects
None yet
Development

No branches or pull requests

2 participants