Enhancements 34, 35, 36, 50 #40

nate-double-u · 2020-10-16T18:13:51Z

Using css for logo width in navbar partial. Fixes #36
Adding CNCF Branding Elements Near Bottom of home page. Fixes #35
Adding Linux Foundation copyright notice to footer. Fixes #34
Add GitHub button to top level nav. Fixes #50

nate-double-u · 2020-10-16T18:15:09Z

Deploy preview: https://deploy-preview-40--cncf-hugo-starter.netlify.app/

- Adding CNCF Branding Elements Near Bottom of home page. Fixes #35 - Adding Linux Foundation copyright notice to footer. Fixes #34 - Using css for logo width in navbar partial. Fixes #36 Co-authored-by: Celeste Horgan <celeste@cncf.io> Co-authored-by: Nate W <nwaddington@cncf.io> Signed-off-by: Nate W <nwaddington@cncf.io>

zacharysarah

@nate-double-u Some small changes. Thanks for upstreaming these!

config.toml

content/test-content/docs-section-1/_index.md

zacharysarah · 2020-10-27T23:52:31Z

layouts/partials/footer.html

+      {{ with site.Copyright }}
+      &copy; {{ $year }} {{ . }} </br>
+      {{ end }}


This renders oddly on the page. I don't know if the CNCF holds trademarks independently from the LF, and I would avoid adding custom boilerplate without clear guidance from legal.

I think the odd rendering is an artifact of the page responsiveness--this element tracks with the header, and not the content, so for some viewports it can look odd.

I think we should probably open an issue for responsiveness generally, and probably one for mobile rendering specifically.

I don't know if the CNCF holds trademarks independently from the LF, and I would avoid adding custom boilerplate without clear guidance from legal.

The double copyright lines has confused me for a couple weeks now. I see it on a lot of our project pages. I can try to find the issue i mentioned it in before.

Specifically for the template though, the "Cloud Native Computing Foundation" comes in from the config.toml, which we are expecting people to change when they generate a site from the template, so in practice we'd never actually see both of:

© 2020 Cloud Native Computing Foundation
© 2020 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.

So because the CNCF copyright mark should be removed as a part of the initial site setup work, I think I'm OK leaving this as is.

That all said, how do we get that clear guidance from legal?

Issue for responsiveness issues: #52

@zacharysarah – What renders as © 2020 Cloud Native Computing Foundation is actually © 2020 ProjectName in reality. So for Longhorn, this would be © 2020 Longhorn, for Vitess © 2020 Vitess, etc.

What I suggest for this, @nate-double-u:

Change the string to render to © 2020 The ProjectName Authors | Documentation Distributed under CC-BY-4.0, which is what we actually use on 98% of projects.

The reason the second copyright line is there: the first copyright line (ProjectName Authors) == covers the actual code and docs. The second copyright line (Linux Foundation) covers the logos and trademarks.

That makes sense @celestehorgan, I'll add that change in; however, @zacharysarah, do we still need legal review? If so, at which stage of the process do we need it?

It's already published at https://cncf-hugo-starter.netlify.app/, as follows:

1. Change the string to render to `© 2020 The ProjectName Authors | Documentation Distributed under CC-BY-4.0`

@celestehorgan is it reasonable/safe, at least in the template here, to use the site.Title parameter within that string in place of "ProjectName"? (see my commit here for how I intend to make this edit)

If we do it that way, likely we can take the copyright entry out of the config.toml file.

@nate-double-u I would actually do the following:

Rename copyright to projectName here (to make it clearer)

Reference projectName in the copyright footer, but also anywhere else we might use it.

Let title be its own thing that populates a page's <title> tag, i.e.

The reason I'd do it this way is because sometimes sites SEO-ify their <title> tag, and so we can't be guaranteed it's going to be a clean string of the project name every time.

@celestehorgan that sounds good, I'll make that update.

layouts/partials/home/cncf-status.html

Removing markup from anchor text. Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

Removing unneeded period. Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

Removing conference callout. Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

fixes: #50 Signed-off-by: Nate W <nwaddington@cncf.io>

Signed-off-by: Nate W <nwaddington@cncf.io>

celestehorgan · 2020-10-29T21:18:04Z

assets/sass/custom.sass

@@ -66,6 +66,9 @@

 $font-family-headers: "Fira Sans" 

+.logo
+  max-width: 200px


lgtm, sign-off on #36

celestehorgan · 2020-10-29T21:28:17Z

config.toml

@@ -17,6 +17,12 @@ contentDir = "/content/"
 [params.logos]
 navbar = "cncf-color.png"

+[[params.social]]


On the whole, these are meant to be add-as-you-please, rather than a set that a project has to fill out – regardless, LGTM on #50

I wanted to add it as a way of inviting folks to participate in the starter too :)

celestehorgan · 2020-10-29T21:28:32Z

content/test-content/docs-section-1/_index.md

@@ -1,5 +1,6 @@
 ---
 title: "Section 1 index"
+linkTitle: "Section 1 index and linkTitle Sample"


layouts/partials/home/cncf-status.html

celestehorgan · 2020-10-29T21:36:27Z

layouts/partials/github-edit.html

@@ -1,7 +1,7 @@
 <div class="col col-4">
    {{ $repoUrl := .Site.Params.repositoryUrl }}
    {{ $filePath := .File.Path }}
-    {{ $editUrl := print $repoUrl "/content/" $filePath }}
+    {{ $editUrl := print $repoUrl "/blob/main/content/" $filePath }}


Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Celeste Horgan <celeste@cncf.io>

Removing `</br>`, wrapping both lines with `<p>` Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Celeste Horgan <celeste@cncf.io>

Signed-off-by: Nate W <nwaddington@cncf.io>

…ht notice. Signed-off-by: Nate W <nwaddington@cncf.io>

nate-double-u · 2020-11-04T22:10:09Z

@zacharysarah @celestehorgan can we merge this in and open a separate tix for the legal/copyright discussion?

celestehorgan

Per @nate-double-u's suggestion, let's get clarification on the copyright seperately and merge this.

Nate, please rebase the PR and merge.

Signed-off-by: Nate W <nwaddington@cncf.io> # Conflicts: # content/test-content/docs-section-1/_index.md

Approving and continuing conversation in a subsequent pr

nate-double-u requested a review from celestehorgan October 16, 2020 18:13

nate-double-u marked this pull request as ready for review October 16, 2020 18:52

nate-double-u requested review from zacharysarah and celestehorgan and removed request for celestehorgan October 27, 2020 23:37

zacharysarah previously requested changes Oct 27, 2020

View reviewed changes

nate-double-u and others added 4 commits October 27, 2020 23:58

Update content/test-content/docs-section-1/_index.md

60b4467

Removing markup from anchor text. Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

Update config.toml

c5f94aa

Removing unneeded period. Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

Update layouts/partials/home/cncf-status.html

8d94d4a

Removing conference callout. Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>

Adding GitHub button to top level nav

edb7a81

fixes: #50 Signed-off-by: Nate W <nwaddington@cncf.io>

nate-double-u changed the title ~~Enhancements 34, 35, 36~~ Enhancements 34, 35, 36, 50 Oct 28, 2020

nate-double-u added 2 commits October 28, 2020 16:26

adding site.Title to cncf status.

cc2e8a2

Signed-off-by: Nate W <nwaddington@cncf.io>

adding trim_trailing_whitespace to markdown section in .editorconfig

b55a3f2

Signed-off-by: Nate W <nwaddington@cncf.io>

nate-double-u requested a review from zacharysarah October 28, 2020 23:32

celestehorgan reviewed Oct 29, 2020

View reviewed changes

assets/sass/custom.sass

@@ -66,6 +66,9 @@

$font-family-headers: "Fira Sans"

.logo

max-width: 200px

Copy link

Contributor

celestehorgan Oct 29, 2020

Choose a reason for hiding this comment

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

lgtm, sign-off on #36

celestehorgan reviewed Oct 29, 2020

View reviewed changes

layouts/partials/home/cncf-status.html Outdated Show resolved Hide resolved

celestehorgan reviewed Oct 29, 2020

View reviewed changes

layouts/partials/home/cncf-status.html Outdated Show resolved Hide resolved

celestehorgan reviewed Oct 29, 2020

View reviewed changes

nate-double-u and others added 5 commits October 29, 2020 21:37

Update layouts/partials/home/cncf-status.html

82d1146

Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Celeste Horgan <celeste@cncf.io>

Update layouts/partials/home/cncf-status.html

3400467

Removing `</br>`, wrapping both lines with `<p>` Signed-off-by: Nate W <nwaddington@cncf.io> Co-authored-by: Celeste Horgan <celeste@cncf.io>

updating copyright in footer.

6ae369e

Signed-off-by: Nate W <nwaddington@cncf.io>

correcting shortcode

8faed67

Signed-off-by: Nate W <nwaddington@cncf.io>

updating config.toml to provide projectName for use in footer copyrig…

9736809

…ht notice. Signed-off-by: Nate W <nwaddington@cncf.io>

nate-double-u mentioned this pull request Oct 30, 2020

Incorporate upstream feedback updates containernetworking/cni.dev#20

Closed

5 tasks

celestehorgan self-requested a review November 5, 2020 21:08

celestehorgan previously approved these changes Nov 5, 2020

View reviewed changes

Merge branch 'main' into enhancements

7df7453

Signed-off-by: Nate W <nwaddington@cncf.io> # Conflicts: # content/test-content/docs-section-1/_index.md

nate-double-u dismissed celestehorgan’s stale review via 7df7453 November 5, 2020 23:09

celestehorgan approved these changes Nov 5, 2020

View reviewed changes

nate-double-u merged commit a13e995 into cncf:main Nov 5, 2020

nate-double-u deleted the enhancements branch November 5, 2020 23:15

nate-double-u mentioned this pull request Nov 5, 2020

Copyright boilerplate & LICENSE #58

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhancements 34, 35, 36, 50 #40

Enhancements 34, 35, 36, 50 #40

nate-double-u commented Oct 16, 2020 •

edited

Loading

nate-double-u commented Oct 16, 2020

zacharysarah left a comment

zacharysarah Oct 27, 2020

nate-double-u Oct 28, 2020

nate-double-u Oct 28, 2020

nate-double-u Oct 28, 2020

celestehorgan Oct 29, 2020

nate-double-u Oct 29, 2020 •

edited

Loading

nate-double-u Oct 29, 2020 •

edited

Loading

nate-double-u Oct 29, 2020 •

edited

Loading

celestehorgan Oct 30, 2020

nate-double-u Oct 30, 2020

celestehorgan Oct 29, 2020

celestehorgan Oct 29, 2020

nate-double-u Oct 29, 2020

celestehorgan Oct 29, 2020

celestehorgan Oct 29, 2020

nate-double-u commented Nov 4, 2020

celestehorgan left a comment

Enhancements 34, 35, 36, 50 #40

Enhancements 34, 35, 36, 50 #40

Conversation

nate-double-u commented Oct 16, 2020 • edited Loading

nate-double-u commented Oct 16, 2020

zacharysarah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nate-double-u Oct 29, 2020 • edited Loading

Choose a reason for hiding this comment

nate-double-u Oct 29, 2020 • edited Loading

Choose a reason for hiding this comment

nate-double-u Oct 29, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nate-double-u commented Nov 4, 2020

celestehorgan left a comment

Choose a reason for hiding this comment

nate-double-u commented Oct 16, 2020 •

edited

Loading

nate-double-u Oct 29, 2020 •

edited

Loading

nate-double-u Oct 29, 2020 •

edited

Loading

nate-double-u Oct 29, 2020 •

edited

Loading