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

just-the-docs.com copyright is out of date #1383

Open
392781 opened this issue Oct 30, 2023 · 4 comments · May be fixed by #1384
Open

just-the-docs.com copyright is out of date #1383

392781 opened this issue Oct 30, 2023 · 4 comments · May be fixed by #1384
Labels
bug status: needs discussion Issues that need more discussion before they can be properly triaged.

Comments

@392781
Copy link

392781 commented Oct 30, 2023

Describe the bug

The documentation website copyright at the bottom is out of date.

To Reproduce

A quick visit to the website and a scroll all the way down.

Expected behavior
Copyright should get updated every year :^)

Screenshots
image

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

@392781 392781 added the bug label Oct 30, 2023
@392781
Copy link
Author

392781 commented Oct 30, 2023

Here is a potentially quick fix by adding to the custom footer as follows:

<p class="text-small text-grey-dk-100 mb-0">
    Copyright &copy; 2017-{{ site.time | date: '%Y' }} {{ site.footer_content }}</a>"
</p>

...while retaining the _config.yml footer_content flag (with just a small change):

footer_content: "Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a> <a href=\"https://www.netlify.com/\">This site is powered by Netlify.</a>"

And adding the following lines to the deploy.yml and CI.yml workflows:

on:
  push:
    branches: ["main"]
  schedule:
    - cron: '0 0 1 1 *'  # Run at 12:00 AM 01/01 every year to update copyright date

This will make it so that the website is rebuilt on the beginning of each year to update copyright!

@392781 392781 linked a pull request Oct 30, 2023 that will close this issue
@392781
Copy link
Author

392781 commented Oct 31, 2023

Is it possible to link the pull request (#1384) I opened to this issue (I think a maintainer needs to do it)

@mattxwang
Copy link
Member

Thanks for submitting an issue @392781! There's actually a reason that we haven't updated this just yet - I need to figure out with Patrick exactly how he wants the copyright for this to work (he transitioned this into this GitHub organization and stepped down as a maintainer in 2020). I've elected to not update the copyright footer until we've sorted that out. This is a good reminder for me to check in with him though!

Separately - I don't think a cron job (or even a custom footer) is necessary for this feature - it's infrequent enough that we can just update it manually, or use a "wildcard" of sorts (e.g. 2017-* or 2020-*).

Do any other maintainers want to chime in? I'll send Patrick an email once the work day is over for me!

@392781
Copy link
Author

392781 commented Nov 2, 2023

IMO, it's simple enough future-proofing that doesn't have significant impact on development while keeping the website looking professional and up to date. Its pretty common to see out of date copyrights for manually updated websites... it's small enough to slip through the cracks.

That said, I didn't realize there was some historical things to take care of. If anything, these changes may be useful for someone downstream using just-the-docs :^) I mainly created the pull because it's an elegant solution that we're using for our documentation.

@mattxwang mattxwang added the status: needs discussion Issues that need more discussion before they can be properly triaged. label Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug status: needs discussion Issues that need more discussion before they can be properly triaged.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants