Skip to content

Commit 21da17a

Browse files
committed
chore(docs): update notice file
- add missing site ico - add additional notice details for documentation usage of third party logos Signed-off-by: Cory Rylan <crylan@nvidia.com>
1 parent 1bc197e commit 21da17a

8 files changed

Lines changed: 24 additions & 5 deletions

File tree

‎.vale.ini‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ Elements.SummaryActionable = NO
1818
Elements.SummaryGerund = NO
1919
Elements.SummaryImplementation = NO
2020

21+
[NOTICE.md]
22+
BasedOnStyles =
23+
24+
[**/NOTICE.md]
25+
BasedOnStyles =
26+
2127
[*.ts]
2228
BasedOnStyles = Vale, write-good, Elements
2329
write-good.TooWordy = error

‎NOTICE.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ NOTICE
33
Elements - NVIDIA Elements Design System
44
Copyright 2024-2026 NVIDIA Corporation
55

6+
For notices about third-party logos used in the documentation, see the [Third-Party Logos Notice](projects/site/public/static/images/integrations/NOTICE.md).
7+
68
This product includes the following bundled third-party software:
79

810
-@eslint/css v1.2.0 [Apache-2.0] (used by: @nvidia-elements/lint)

‎context7.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"url": "https://context7.com/nvidia/elements",
3+
"public_key": "pk_Fl8gaKnysaB1QxvxITto5"
4+
}

‎projects/internals/ci/notice/index.js‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { renderProjectNotice, renderRootNotice } from './template.js';
77
const__dirname=url.fileURLToPath(newURL('.',import.meta.url));
88
constREPO_ROOT=path.resolve(__dirname,'../../../../');
99
constPROJECTS_DIR=path.join(REPO_ROOT,'projects');
10+
constDOCUMENTATION_LOGOS_NOTICE='projects/site/public/static/images/integrations/NOTICE.md';
1011

1112
constNOTICE_CONFIG_FIELDS=newSet(['bundled','assets']);
1213
constBUNDLED_FIELDS=newSet(['name','version','license','author']);
@@ -212,4 +213,8 @@ for (const { projectDir, deps, assets } of resolved) {
212213

213214
constrootEntries=aggregateForRoot(resolved);
214215
constrootPath=path.join(REPO_ROOT,'NOTICE.md');
215-
writeFileIfChanged(rootPath,awaitformatMarkdown(rootPath,renderRootNotice(rootEntries)));
216+
constdocumentationLogosNoticePath=path.join(REPO_ROOT,DOCUMENTATION_LOGOS_NOTICE);
217+
if(!existsSync(documentationLogosNoticePath)){
218+
thrownewError(`Could not locate documentation logos notice at "${documentationLogosNoticePath}".`);
219+
}
220+
writeFileIfChanged(rootPath,awaitformatMarkdown(rootPath,renderRootNotice(rootEntries,DOCUMENTATION_LOGOS_NOTICE)));

‎projects/internals/ci/notice/template.js‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,12 @@ ${licenseSections}
120120
${footer}`;
121121
}
122122

123-
exportfunctionrenderRootNotice(entries){
123+
exportfunctionrenderRootNotice(entries,documentationLogosNotice){
124124
constsorted=entries.slice().sort((a,b)=>byNameCI(a.dep,b.dep));
125+
constdocumentationLogos=`For notices about third-party logos used in the documentation, see the [Third-Party Logos Notice](${documentationLogosNotice}).`;
125126

126127
if(sorted.length===0){
127-
return`${HEADER}\n${EMPTY_BODY}`;
128+
return`${HEADER}\n${documentationLogos}\n\n${EMPTY_BODY}`;
128129
}
129130

130131
constsummary=sorted.map(e=>renderSummaryDep(e.dep,e.usedBy)).join('\n\n');
@@ -133,6 +134,8 @@ export function renderRootNotice(entries) {
133134
constfooter=renderFooter(sorted.map(e=>e.dep.license));
134135

135136
return`${HEADER}
137+
${documentationLogos}
138+
136139
${DEPS_INTRO_ROOT}
137140
138141
${summary}

‎projects/site/public/favicon.svg‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

projects/site/public/static/images/integrations/NOTICE renamed to projects/site/public/static/images/integrations/NOTICE.md

File renamed without changes.

‎projects/site/src/_11ty/layouts/common.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export const renderBaseHead = data => {
4343
<meta name="twitter:description" content="${escapeAttr(meta.description)}">
4444
<meta name="twitter:image" content="${meta.ogImage}">
4545
<meta name="twitter:image:alt" content="${escapeAttr(meta.ogImageAlt)}">
46-
<link rel="icon" href="/favicon.svg">
46+
<link rel="icon" href="https://avatars.githubusercontent.com/u/1728152">
4747
<meta name="google-site-verification" content="pqQ1zOnKkqdZ2Lm0H8qIQx3q1x6Q7ghbumSrwzF_KSY" />
4848
<meta name="msvalidate.01" content="590EBF38676B077801C72048F4D8B5CB" />
4949
${renderJsonLd(data,meta)}

0 commit comments

Comments
 (0)