Skip to content

Commit

Permalink
docs(PPDSC-2204): release notes (#319)
Browse files Browse the repository at this point in the history 
* docs(PPDSC-2204): add release notes page

- Fetch release notes markdown from github api
- Parse markdown for display
- Remove comments and invalid link structures
- Add hyperlinks to tickets, PRs, profiles and release comparisons
- Infer release type by comparing semver against previous release

* docs(PPDSC-2204): temporarily show a major release for review

* docs(PPDSC-2204): fix github profile links

* docs(PPDSC-2204): format date

* docs(PPDSC-2204): add need help card

* docs(PPDSC-2204): format notes typography

* docs(PPDSC-2204): add github link

* docs(PPDSC-2204): use page template

* docs(PPDSC-2204): restructure so build passes

* docs(PPDSC-2204): component tests added

* docs(PPDSC-2204): restructure dirs

* docs(PPDSC-2204): api call tests

* docs(PPDSC-2204): markdown text colour

* docs(PPDSC-2204): tidy up markdown

* docs(PPDSC-2204): add margin between header and notes

* docs(PPDSC-2204): replace anchors for link components

* docs(PPDSC-2204): format links correctly

* docs(PPDSC-2204): correct badge colours

* docs(PPDSC-2204): update badge colours

* docs(PPDSC-2204): update icon import

* docs(PPDSC-2204): remove fake major release

* docs(PPDSC-2204): update final release info
  • Loading branch information
@mstuartf
mstuartf authored Aug 9, 2022
1 parent db736d5 commit d69ffbd
Show file tree
Hide file tree
Showing 22 changed files with 2,341 additions and 143 deletions.
18 changes: 10 additions & 8 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@
"@commitlint/parse": "8.0.0",
"@commitlint/read": "8.0.0",
"@emotion/jest": "^11.2.1",
"@emotion/react": "^11.1.5",
"@emotion/styled": "^11.1.5",
"@hookform/resolvers": "^2.5.0",
"@mapbox/rehype-prism": "^0.3.1",
"@mdx-js/loader": "^1.5.8",
Expand Down Expand Up @@ -118,6 +120,7 @@
"@types/react-transition-group": "^4.4.1",
"@types/react-virtualized": "^9.21.2",
"@types/resize-observer-browser": "^0.1.5",
"@types/semver": "^7.3.10",
"@types/smoothscroll-polyfill": "^0.3.1",
"@types/tar": "^4.0.2",
"@types/webpack": "^4.4.34",
Expand Down Expand Up @@ -171,7 +174,7 @@
"react-codesandboxer": "^3.1.1",
"react-dom": "17",
"react-helmet": "^5.2.1",
"react-markdown": "^4.0.3",
"react-markdown": "^6.0.0",
"react-phone-number-input": "^3.1.23",
"react-syntax-highlighter": "^13.0.0",
"react-test-renderer": "17",
Expand All @@ -186,9 +189,7 @@
"webpack": "^4.17.1",
"webpack-cli": "^3.1.0",
"yo": "^3.1.1",
"yup": "^0.32.9",
"@emotion/react": "^11.1.5",
"@emotion/styled": "^11.1.5"
"yup": "^0.32.9"
},
"dependencies": {
"@babel/runtime-corejs3": "^7.11.2",
Expand All @@ -213,19 +214,20 @@
"react-hot-toast": "^1.0.2",
"react-range": "^1.8.12",
"react-transition-group": "^4.4.1",
"react-virtual": "^2.10.4"
"react-virtual": "^2.10.4",
"semver": "^7.3.7"
},
"resolutions": {
"@types/react": "17",
"minimist": "^0.2.1",
"kind-of": "^6.0.3"
},
"peerDependencies": {
"@emotion/react": ">= 11.1.5 <= 11.9.3",
"@emotion/styled": ">= 11.1.5 <= 11.9.3",
"react": ">= 16.8.0 <= 17",
"react-dom": ">= 16.8.0 <= 17",
"react-is": ">= 16.8.0 <= 17",
"@emotion/react": ">= 11.1.5 <= 11.9.3",
"@emotion/styled": ">= 11.1.5 <= 11.9.3"
"react-is": ">= 16.8.0 <= 17"
},
"husky": {
"hooks": {
Expand Down
10 changes: 8 additions & 2 deletions site/components/content-structure/content-section.tsx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import React from 'react';
import {ContentSectionProps} from './types';

export const ContentSection: React.FC<ContentSectionProps> = ({children}) => (
<section>{children}</section>
export const ContentSection: React.FC<ContentSectionProps> = ({
children,
toc,
id,
}) => (
<section id={id} data-toc-indexed={toc}>
{children}
</section>
);
2 changes: 2 additions & 0 deletions site/components/content-structure/types.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,6 @@ export type ContentTertiaryProps = Omit<
export type ContentSectionProps = {
children: React.ReactNode;
sectionName?: string;
toc?: string;
id?: string;
};
134 changes: 134 additions & 0 deletions site/components/illustrations/about/release-notes-hero-illustration.tsx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
import React from 'react';
import {getSSRId} from 'newskit';
import {Svg} from '../svg';
import {Path} from '../path';
import {Rect} from '../rect';

export const ReleaseNotesHeroIllustration: React.FC = () => {
const mask0 = getSSRId();
const mask1 = getSSRId();
const mask2 = getSSRId();

return (
<Svg
width="1344"
height="759"
viewBox="0 0 1344 759"
fill="none"
xmlns="http://www.w3.org/2000/svg"
>
<Rect width="1344" height="759" fill="illustrationBackground020" />
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M1005.69 238.781C1005.31 240.849 1003.33 242.224 1001.27 241.851C1000.44 241.702 999.611 241.555 998.781 241.408C996.711 241.044 995.328 239.071 995.693 237.001C996.057 234.932 998.031 233.549 1000.1 233.914C1000.94 234.062 1001.78 234.211 1002.62 234.362C1004.68 234.735 1006.06 236.713 1005.69 238.781ZM978.135 234.248C977.845 236.329 975.922 237.782 973.84 237.492C973.007 237.376 972.173 237.261 971.337 237.148C970.723 237.064 970.109 236.981 969.494 236.899C967.41 236.621 965.946 234.707 966.225 232.624C966.503 230.541 968.418 229.078 970.501 229.356C971.123 229.439 971.743 229.523 972.363 229.607C973.207 229.722 974.049 229.838 974.89 229.955C976.972 230.245 978.425 232.167 978.135 234.248ZM955.104 231.27C954.872 233.358 952.991 234.864 950.901 234.632C949.658 234.494 948.411 234.358 947.162 234.225C945.072 234.002 943.558 232.127 943.781 230.038C944.004 227.948 945.88 226.435 947.97 226.658C949.23 226.793 950.487 226.93 951.741 227.069C953.83 227.3 955.336 229.181 955.104 231.27ZM932.62 228.96C932.437 231.053 930.592 232.602 928.497 232.42C927.256 232.312 926.012 232.206 924.766 232.102C922.671 231.927 921.115 230.087 921.29 227.993C921.465 225.899 923.305 224.343 925.4 224.518C926.655 224.623 927.908 224.73 929.158 224.839C931.253 225.021 932.802 226.866 932.62 228.96ZM910.095 227.158C909.956 229.255 908.142 230.842 906.045 230.703C904.797 230.62 903.548 230.539 902.296 230.46C900.198 230.328 898.605 228.52 898.737 226.423C898.869 224.326 900.677 222.733 902.775 222.865C904.035 222.945 905.293 223.026 906.549 223.109C908.646 223.249 910.234 225.061 910.095 227.158ZM887.549 225.805C887.448 227.904 885.664 229.524 883.565 229.424C882.315 229.364 881.064 229.306 879.812 229.249C877.712 229.155 876.086 227.377 876.18 225.277C876.275 223.178 878.054 221.553 880.154 221.647C881.414 221.704 882.672 221.762 883.929 221.823C886.028 221.923 887.649 223.706 887.549 225.805ZM864.96 224.852C864.894 226.952 863.138 228.601 861.036 228.536C859.79 228.497 858.542 228.459 857.292 228.423C855.191 228.363 853.536 226.611 853.597 224.511C853.657 222.41 855.409 220.756 857.511 220.817C858.767 220.853 860.021 220.89 861.275 220.929C863.376 220.995 865.026 222.751 864.96 224.852ZM842.385 224.26C842.351 226.361 840.619 228.036 838.517 228.002C837.265 227.981 836.011 227.962 834.757 227.945C832.655 227.915 830.975 226.188 831.004 224.087C831.034 221.985 832.762 220.306 834.864 220.335C836.124 220.353 837.383 220.372 838.642 220.393C840.744 220.427 842.42 222.158 842.385 224.26ZM819.786 223.994C819.78 226.095 818.072 227.794 815.969 227.788C814.719 227.785 813.468 227.783 812.216 227.782C810.114 227.781 808.411 226.076 808.412 223.975C808.413 221.873 810.118 220.171 812.221 220.172C813.478 220.173 814.734 220.175 815.99 220.178C818.093 220.184 819.792 221.893 819.786 223.994ZM797.195 224.027C797.216 226.128 795.528 227.848 793.426 227.868C792.173 227.881 790.92 227.894 789.666 227.909C787.564 227.933 785.84 226.25 785.816 224.149C785.791 222.047 787.475 220.324 789.577 220.299C790.836 220.285 792.094 220.271 793.352 220.259C795.454 220.239 797.175 221.926 797.195 224.027ZM774.601 224.334C774.646 226.435 772.978 228.174 770.876 228.219C769.624 228.245 768.371 228.273 767.119 228.302C765.017 228.35 763.274 226.686 763.226 224.586C763.177 222.485 764.842 220.743 766.943 220.694C768.201 220.665 769.458 220.637 770.715 220.611C772.817 220.566 774.556 222.233 774.601 224.334ZM752.013 224.895C752.081 226.995 750.432 228.752 748.33 228.819C747.078 228.859 745.826 228.9 744.574 228.942C742.474 229.012 740.713 227.367 740.642 225.267C740.572 223.167 742.218 221.407 744.319 221.336C745.575 221.294 746.831 221.253 748.088 221.213C750.189 221.146 751.946 222.794 752.013 224.895ZM729.433 225.691C729.521 227.79 727.89 229.563 725.789 229.651C724.536 229.704 723.283 229.757 722.031 229.812C719.931 229.903 718.154 228.275 718.063 226.176C717.972 224.076 719.6 222.3 721.7 222.209C722.957 222.155 724.213 222.101 725.471 222.048C727.571 221.96 729.345 223.591 729.433 225.691ZM706.86 226.707C706.968 228.805 705.353 230.594 703.254 230.701C702.003 230.765 700.754 230.83 699.505 230.896C697.405 231.007 695.614 229.396 695.503 227.297C695.392 225.199 697.004 223.408 699.104 223.297C700.356 223.231 701.61 223.166 702.864 223.102C704.963 222.994 706.753 224.608 706.86 226.707ZM684.298 227.929C684.424 230.027 682.825 231.83 680.726 231.956C679.473 232.031 678.221 232.107 676.971 232.184C674.872 232.313 673.067 230.717 672.938 228.62C672.809 226.522 674.405 224.717 676.503 224.588C677.758 224.511 679.013 224.435 680.27 224.36C682.368 224.234 684.172 225.832 684.298 227.929ZM661.75 229.347C661.894 231.443 660.31 233.259 658.213 233.403C656.962 233.488 655.713 233.575 654.465 233.662C652.368 233.808 650.55 232.227 650.403 230.131C650.257 228.035 651.838 226.217 653.935 226.07C655.186 225.983 656.439 225.896 657.693 225.811C659.79 225.667 661.607 227.25 661.75 229.347ZM639.205 230.95C639.366 233.045 637.796 234.873 635.7 235.033C634.449 235.129 633.199 235.225 631.952 235.322C629.856 235.485 628.025 233.919 627.862 231.824C627.699 229.728 629.266 227.898 631.362 227.735C632.613 227.638 633.866 227.542 635.12 227.446C637.216 227.286 639.045 228.854 639.205 230.95ZM616.701 232.726C616.877 234.82 615.322 236.66 613.227 236.836C611.969 236.942 610.714 237.048 609.461 237.155C607.367 237.334 605.524 235.781 605.345 233.688C605.166 231.594 606.72 229.752 608.814 229.573C610.07 229.466 611.328 229.359 612.589 229.253C614.684 229.077 616.525 230.632 616.701 232.726ZM594.169 234.675C594.36 236.768 592.818 238.619 590.725 238.811C589.479 238.924 588.236 239.039 586.995 239.154C584.902 239.347 583.048 237.808 582.854 235.716C582.66 233.623 584.2 231.77 586.293 231.576C587.537 231.461 588.783 231.347 590.032 231.232C592.125 231.041 593.977 232.582 594.169 234.675ZM571.673 236.785C571.879 238.876 570.35 240.738 568.258 240.944C567.006 241.068 565.758 241.191 564.513 241.315C562.421 241.524 560.556 239.998 560.347 237.907C560.139 235.816 561.665 233.952 563.757 233.743C565.005 233.619 566.257 233.495 567.511 233.371C569.603 233.165 571.466 234.693 571.673 236.785ZM549.213 239.049C549.434 241.139 547.918 243.012 545.828 243.232C544.569 243.365 543.314 243.498 542.063 243.632C539.973 243.854 538.097 242.341 537.874 240.252C537.651 238.162 539.165 236.288 541.256 236.065C542.509 235.931 543.767 235.798 545.029 235.665C547.119 235.444 548.993 236.959 549.213 239.049ZM526.739 241.471C526.973 243.559 525.47 245.442 523.381 245.677C522.763 245.746 522.147 245.816 521.531 245.885C519.442 246.121 517.558 244.619 517.322 242.531C517.086 240.443 518.588 238.559 520.677 238.324C521.294 238.254 521.912 238.184 522.531 238.115C524.62 237.88 526.504 239.383 526.739 241.471Z"
fill="interface050"
/>
<mask
id={mask0}
maskUnits="userSpaceOnUse"
x="665"
y="160"
width="378"
height="377"
>
<Path
d="M853.802 536.718C958.042 536.718 1042.55 452.441 1042.55 348.48C1042.55 244.518 958.042 160.241 853.802 160.241C749.562 160.241 665.059 244.518 665.059 348.48C665.059 452.441 749.562 536.718 853.802 536.718Z"
fill="white"
/>
</mask>
<g mask={`url(#${mask0})`}>
<Path
d="M853.802 536.718C958.042 536.718 1042.55 452.441 1042.55 348.48C1042.55 244.518 958.042 160.241 853.802 160.241C749.562 160.241 665.059 244.518 665.059 348.48C665.059 452.441 749.562 536.718 853.802 536.718Z"
fill="#2B4AAB"
/>
</g>
<mask
id={mask1}
maskUnits="userSpaceOnUse"
x="665"
y="160"
width="378"
height="377"
>
<Path
d="M853.802 536.718C958.042 536.718 1042.55 452.441 1042.55 348.48C1042.55 244.518 958.042 160.241 853.802 160.241C749.562 160.241 665.059 244.518 665.059 348.48C665.059 452.441 749.562 536.718 853.802 536.718Z"
fill="white"
/>
</mask>
<g mask={`url(#${mask1})`}>
<Path
d="M853.802 536.718C958.042 536.718 1042.55 452.441 1042.55 348.48C1042.55 244.518 958.042 160.241 853.802 160.241C749.562 160.241 665.059 244.518 665.059 348.48C665.059 452.441 749.562 536.718 853.802 536.718Z"
fill="blue070"
/>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M666.225 330.364C657.1 430.563 704.459 467.047 705.511 468.033C736.245 496.835 805.11 553.347 865.644 548.317C926.177 543.287 1013.13 440.097 970.45 367.673C931.885 302.228 956.356 246.863 925.058 216.057C893.76 185.25 841.619 169.552 785.138 180.297C728.658 191.043 675.351 230.166 666.225 330.364Z"
fill="blue060"
/>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M651.056 419.395C624.963 348.712 652.305 313.125 652.878 312.208C669.627 285.408 692.398 248.23 737.38 240.103C782.362 231.976 842.098 267.704 843.324 268.557C867.587 285.433 855.427 330.233 864.206 362.963C873.637 398.128 880.377 428.096 863.608 456.456C846.839 484.815 800.972 495.613 766.643 504.803C733.173 513.763 677.148 490.078 651.056 419.395Z"
fill="blue050"
/>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M648.557 411.531C633.583 370.969 649.274 350.547 649.603 350.02C659.214 334.641 672.282 313.306 698.095 308.642C723.908 303.978 758.189 324.481 758.893 324.971C772.816 334.655 765.838 360.364 770.876 379.147C776.288 399.327 780.156 416.524 770.533 432.799C760.909 449.073 734.588 455.27 714.888 460.544C695.681 465.685 663.53 452.094 648.557 411.531Z"
fill="blue030"
/>
</g>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M978.037 238.462C978.373 236.388 980.328 234.979 982.403 235.315C997.41 237.746 1009.55 239.968 1018.8 241.982C1048.45 248.334 1069.62 263.234 1081.37 283.075C1093.12 302.905 1095.2 327.22 1087.53 351.874C1072.19 401.138 1018.09 451.803 923.299 474.029C814.244 499.599 668.685 503.284 543.47 499.689C418.182 496.091 312.886 485.19 284.167 481.438C282.083 481.165 280.614 479.256 280.886 477.172C281.159 475.088 283.069 473.62 285.154 473.892C313.623 477.611 418.663 488.492 543.688 492.082C668.786 495.674 813.518 491.953 921.56 466.621C1014.7 444.782 1065.98 395.475 1080.26 349.614C1087.39 326.705 1085.32 304.669 1074.82 286.953C1064.33 269.249 1045.16 255.411 1017.2 249.422L1017.19 249.42C1008.13 247.446 996.134 245.248 981.185 242.827C979.11 242.49 977.7 240.536 978.037 238.462Z"
fill="interface050"
/>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M1042.55 348.479C1042.55 284.592 1010.63 228.138 961.838 194.108C931.232 172.763 862.123 161.393 918.256 196.856C942.999 212.488 962.974 234.787 962.974 266.593C962.974 348.946 975.5 330.572 1000.4 399.83C1026.24 387.204 1042.55 370.087 1042.55 348.479Z"
fill="blue070"
/>
<mask
id={mask2}
maskUnits="userSpaceOnUse"
x="225"
y="425"
width="86"
height="87"
>
<Path
d="M267.995 511.468C244.319 511.468 225.126 492.266 225.126 468.578C225.126 444.891 244.319 425.689 267.995 425.689C291.671 425.689 310.864 444.891 310.864 468.578C310.864 492.266 291.671 511.468 267.995 511.468Z"
fill="illustrationInterface040"
/>
</mask>
<g mask={`url(#${mask2})`}>
<Path
d="M267.995 511.468C244.319 511.468 225.126 492.266 225.126 468.578C225.126 444.891 244.319 425.689 267.995 425.689C291.671 425.689 310.864 444.891 310.864 468.578C310.864 492.266 291.671 511.468 267.995 511.468Z"
fill="illustrationInterface040"
/>
<Path
d="M237.573 491.925C224.96 491.925 214.735 481.491 214.735 468.62C214.735 455.75 224.96 445.316 237.573 445.316C250.186 445.316 260.411 455.75 260.411 468.62C260.411 481.491 250.186 491.925 237.573 491.925Z"
fill="blue020"
/>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M259.061 416.779C255.616 416.779 252.249 417.116 248.992 417.758C272.772 422.45 290.707 443.438 290.707 468.62C290.707 493.803 272.772 514.791 248.993 519.483C252.249 520.125 255.616 520.462 259.061 520.462C287.661 520.462 310.845 497.252 310.845 468.62C310.845 439.989 287.661 416.779 259.061 416.779Z"
fill="illustrationInterface050"
/>
</g>
<Path
fillRule="evenodd"
clipRule="evenodd"
d="M506.138 221.599C507.959 222.649 508.584 224.976 507.534 226.796L495.144 248.265L516.602 260.659C518.422 261.711 519.045 264.038 517.993 265.858C516.941 267.677 514.613 268.3 512.793 267.248L488.042 252.952C486.223 251.901 485.6 249.575 486.65 247.756L500.939 222.994C501.99 221.173 504.317 220.549 506.138 221.599Z"
fill="interface050"
/>
</Svg>
);
};

export default ReleaseNotesHeroIllustration;
Loading

0 comments on commit d69ffbd

Please sign in to comment.