Skip to content

July 24 2023 release notes & docs updates #122

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
Merged
merged 28 commits into from
Jul 25, 2023
Merged

July 24 2023 release notes & docs updates #122

merged 28 commits into from
Jul 25, 2023

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jul 23, 2023 •
edited
Loading

Internal Notes for Reviewers

This PR includes:

  • Release notes for the July 24 release
  • Makefile updates for the make notebooks action to pull in the latest notebooks (and simplify future Makefile updates)
  • Updated license agreement
  • Docs for swap template functionality
  • Docs for the client integrations rename
  • Updated Jupyter notebooks page
  • Notebooks download option on some pages (incl. release notes)

In addition, I have updated and tested the notebooks available via Googe Colab (and added the new ones).

Output

Release notes (updated after removing the two new notebooks):

image

License agreement:

image

Swap template docs:

image

External Release Notes

@nrichers nrichers added documentation Improvements or additions to documentation internal Not to be externalized in the release notes labels Jul 23, 2023
@nrichers nrichers marked this pull request as draft July 23, 2023 06:00
@nrichers nrichers requested a review from cachafla July 24, 2023 04:00
@nrichers nrichers changed the title July 24 2023 release notes & docs updates — WIP DO NOT REVIEW July 24 2023 release notes & docs updates Jul 24, 2023
@nrichers nrichers marked this pull request as ready for review July 24, 2023 15:00
@nrichers
Copy link
Collaborator Author

@jonasjacobi I have updated the license agreement, as requested. Here's the output:

image

If you would like to review the changes, they were made under this commit: 52d8c3c

nrichers
nrichers commented Jul 24, 2023
View reviewed changes
nrichers
nrichers commented Jul 24, 2023
View reviewed changes
nrichers
nrichers commented Jul 24, 2023
View reviewed changes
cachafla
cachafla approved these changes Jul 24, 2023
View reviewed changes
Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍.

As discussed on our call today, a minor last-minute fix is to not include Support for Credit Risk Scorecard and Probability of Default use cases from the release notes to give us more time to come up with a solution to host the PD dataset on our servers.

@nrichers
Copy link
Collaborator Author

As discussed on our call today, a minor last-minute fix is to not include Support for Credit Risk Scorecard and Probability of Default use cases from the release notes to give us more time to come up with a solution to host the PD dataset on our servers.

References to these notebooks have been removed, see #122 (comment) for details.

@nrichers nrichers merged commit 9bb53d1 into main Jul 25, 2023
@nrichers nrichers deleted the july-20-2023-release-notes branch July 25, 2023 01:37
sydneysugar pushed a commit that referenced this pull request Jul 25, 2023
@nrichers @sydneysugar
July 24 2023 release notes & docs updates (#122)
d026a50 
* WIP release notes draft

* Fix moved Python script

* Update notebook source from Google Drive

* WIP release notes draft

* WIP release notes updates, fix client integration docs

* WIP release notes draft

* WIP swap templates draft, WIP Makefile and source update

* Update rendered site

* Update Makefile for better notebooks handling

* Move release highlights template to avoid externalizing and to fix broken links

* Makefile tweak

* Fix June release notes link

* Update notebook source & render site

* Improve Makefile output

* Makefile tweak

* Release notes draft complete

* Update Jupyter notebooks page, add download option

* Add notebook downloads to release notes

* Add swap template docs

* Add swap template docs to Quarto YAML

* Fix formatting

* Remove stray line

* Rename Jupyter notebooks section to Samples

* Update license agreement

* Update rendered site

* Address review comments

* Update add content block animation
@nrichers nrichers mentioned this pull request Jul 27, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cachafla cachafla cachafla approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation internal Not to be externalized in the release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nrichers @cachafla