rapidsai / deployment

RAPIDS Deployment Documentation
https://docs.rapids.ai/deployment/stable/
9 stars 28 forks source link

Add script to generate release checklist issue text #237

Closed jacobtomlinson closed 1 year ago

jacobtomlinson commented 1 year ago

Added a small script for generating the release checklist issue text. It lists all the files in the source directory and converts them to nightly URLs in a tasklist. It also adds a header with instructions and a footer with info about how the issue was generated.

Each release we can use this script to quickly generate issues like #198 and #236.

$ ./scripts/gen_release_checklist_issue.sh
# Release checklist

For the upcoming release we need to verify our documentation. This is a best efforts activity
so please refer to the checklist from the previous release and focus on pages that were not
verified last time.

## Verify pages

- Look at the nightly build of each page listed below
- Check page renders correctly
- Check for spelling/grammar problems
- Check that the instructions work as expected
- Ensure legacy pages with out of date instructions have a content warning
- If page needs updating convert the task to an issue and open a PR that closes the issue

```[tasklist]
### Pages
- [ ] https://docs.rapids.ai/deployment/nightly/
- [ ] https://docs.rapids.ai/deployment/nightly/cloud/
- [ ] https://docs.rapids.ai/deployment/nightly/cloud/aws/
- [ ] https://docs.rapids.ai/deployment/nightly/cloud/aws/ec2/

...