Skip to content
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.

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

Include link to pantsbuild.org repo and commit in footer #63

Merged
merged 2 commits into from
Jan 6, 2024

Conversation

huonw
Copy link
Contributor

@huonw huonw commented Jan 5, 2024

This adjusts the "copyright" section of the website footer to include:

  • a link to this repository, replacing the "built with docusaurus" text, since that can be discovered by clicking through to the repo (it be fine to continue to include that if required).
  • a reference to which commit the deployed website is showing, so we can be sure we're looking at what we expect (it would be fine to move this to a HTML comment instead, so it's just available for reference in the rare case it's required).

It also removes the year, since having that auto-update is technically incorrect.

Example:

image

@huonw huonw requested a review from thejcannon January 5, 2024 00:14
@huonw huonw marked this pull request as ready for review January 5, 2024 00:20
@thejcannon
Copy link
Member

  • I just left the Docusaurus tidbit in there because the tech stack is great to work with overall, and the support I got on GitHub and discord was good. Not required at all though.
  • the code commit is a good idea, but it feels weird to put it in the footer. I don't think I feel strongly either way though so I'll ping @benjyw and let him decide

@huonw huonw requested a review from benjyw January 5, 2024 03:17
@@ -28,6 +31,23 @@ const onlyIncludeVersions = isDev
const currentVersion = getCurrentVersion();
const includeBlog = process.env.PANTSBUILD_ORG_INCLUDE_BLOG === "1" || !isDev;

const formatCopyright = () => {
const year = new Date().getFullYear();
Copy link
Contributor

Choose a reason for hiding this comment

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

I know using the current year is common practice, but it's not actually correct. The copyright year should reflect the year of first publication, not the current year (since that conveys no information relevant to the content for which common law copyright is being claimed). So to be meaningful year should be the year of first publication, or the last time the file was substantially modified (if that can be measured).

An easier possibility is to omit the year entirely...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed!

@huonw huonw merged commit be7fb14 into main Jan 6, 2024
1 check passed
@huonw huonw deleted the huonw/footer-links branch January 13, 2024 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants