Meet Apache Website requirements

[paulirwin]

Is there an existing issue for this?

• I have searched the existing issues

Description of Bug

We do not meet several requirements Apache has for top-level project websites. The full list can be seen here: https://whimsy.apache.org/site/project/lucenenet

This includes the original bug report below, about missing images. All external resources should be hosted on Apache servers.

Original Bug Report

The "Popular Books" images on the homepage are broken, seemingly as a result of a CSP change at Amazon.

Expected Behavior

The images appear (or the section is otherwise corrected, perhaps with text links)

Steps To Reproduce

Visit the https://lucenenet.apache.org home page.

Exceptions (if any)

No response

Lucene.NET Version

No response

.NET Version

No response

Operating System

No response

Anything else?

No response

[vwilson]

Good afternoon! The images themselves still exist on amazon's servers. This is a CSP issue. There are several additional issues on the index page - academicons.min.css, font-awesome.min.css, and the roboto mono font.

I think this may need to be addressed by the Apache infra team. (This is my first attempt at contributing to the repo so please forgive my lack of familiarity.)

[paulirwin]

@vwilson Great catch on the other external resources! It turns out there's a lot more work we need to do to meet Apache requirements for the website, too: https://whimsy.apache.org/site/project/lucenenet

Per the Committer's FAQ we should host all resources on our own server. I'll update this item to include the other requirements we need to address as sub-issues.

We welcome your contribution @vwilson if you want to work on any of these! It's a great, easy way to get started with the project. The main repo for the site is at https://github.com/apache/lucenenet-site and has more info in the README.

[NightOwl888]

Being that dependency rot is an ongoing issue with both websites (in addition to GitHub Actions and our NuGet dependencies), perhaps we should look into setting it up so we can automatically upgrade them with Renovate.

• JavaScript
• Node.js

This will allow us to get out in front of many security problems before someone reports them.

Currently the only way to test our websites after being generated is to host them locally, go through the DocFx logs, and click links manually to see if they work. So, even if we automate the upgrades, it would take a bit of work to review the PRs from Renovate. We potentially could also set up an automated testing workflow that does some checks on the static websites that are generated. Or at the very least, set it up so when a PR with a website change is submitted, the website in the PR is built and hosted on a temporary URL so we can preview how the changes affect it without leaving the browser.

---

One more thought: We are only 10 days away from the start of Hacktoberfest. It would be a good idea to divide up some of the smaller tasks (less than ~30 minutes of work) on the website into "good first issue" grooming for potential contributors, which may help to encourage participation.

Perhaps we could also pin a discussion up that links to the "good first issue" URLs and the documentation for how to build the website.

Not that we shouldn't seek contributions in other areas, but the website has historically been a favorite for contributors.

[paulirwin]

One more thought: We are only 10 days away from the start of Hacktoberfest. It would be a good idea to divide up some of the smaller tasks (less than ~30 minutes of work) on the website into "good first issue" grooming for potential contributors, which may help to encourage participation.

Good idea re: Hacktoberfest, and I think I've already done what you describe about dividing the work up. The links issue could all be done quickly at once, and the external dependencies shouldn't be hard to pull together either, as there aren't that many of them and likely would mostly all be done the same or similar ways. But, if someone wants to break that down further once they get into it, I'm fine with that too.