You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucenenet.apache.org by "zka26 (via GitHub)" <gi...@apache.org> on 2025/10/02 09:15:38 UTC
[PR] Added ASF-required footer links in doxfx.json [lucenenet]
zka26 opened a new pull request, #1198:
URL: https://github.com/apache/lucenenet/pull/1198
<!-- Thank you for submitting a pull request to our repo. -->
<!-- Please do NOT submit PRs for features in newer versions of Lucene. We should keep the target version consistent across our repository to make the upgrade process to newer versions of Lucene go smoothly. -->
<!-- If this is your first PR in the Lucene.NET repo, please run through the checklist
below to ensure a smooth review and merge process for your PR. -->
- [x] You've read the [Contributor Guide](https://github.com/apache/lucenenet/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
- [x] You've included unit or integration tests for your change, where applicable.
- [x] You've included inline docs for your change, where applicable.
- [x] There's an open issue for the PR that you are making. If you'd like to propose a change, please [open an issue](https://github.com/apache/lucenenet/issues/new/choose) to discuss the change or find an existing issue.
<!-- Once all that is done, you're ready to go. Open the PR with the content below. -->
Summary of the changes (Less than 80 chars)
Fixes #1186
## Description
This PR adds the Foundation, Events, License, Thanks/(Sponsors), Security, Sponsorship, Privacy (Policy) links that were flagged by the Apache Project Website Checks.
It was inserted into _appFooter in doxfx.json and I left 2024 copyright year unchanged.
<img width="1904" height="943" alt="footer-screenshot" src="https://github.com/user-attachments/assets/6a5c5778-0787-4361-b926-ae33bc162a5e" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 merged PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "zka26 (via GitHub)" <gi...@apache.org>.
zka26 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3379109985
@NightOwl888 - Sorry for the late reply and thanks for checking in! The work is nearly complete. I've extended the navbars with the ASF dropdown menu, adding links for both the main site and the apidocs, and have worked to make them look and behave uniformly in both the pancake and desktop modes.
I'm just putting on the final touches now, fixing a small issue in the apidocs part and reverting some changes in the site part to ensure they look and feel more alike.
Thanks for the heads-up about the trailing whitespaces—I've eliminated them.
I plan to commit the finalized version, edit the PR description, and set it for review in about 10 hours.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "zka26 (via GitHub)" <gi...@apache.org>.
zka26 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3429853139
Sorry, this took longer than expected. The learning curve was trickier than I thought and I decided to restart a few times. I added the ASF-required links via dropdown and unified the navs. I significantly reworked the main.css and main.js files (added main.js for the Site). I tested across viewports/zoom in DevTools to address issues. On the Apidocs, there is a compact search overlay between 1200-1399px to keep a single-line navbar and match the Site. I hope the result feels clean and consistent.
If anything should be reverted, adjusted, included or excluded, please let me know!
I am happy to improve it and take your recommendation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3370017977
@zka26 - I noticed this is still marked as a draft PR. Do you have more work to do or is this ready for review?
Note that the EditorConfig checker also caught some issues with extra trailing whitespace.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3476667702
FYI - these changes are now live. Thanks again for the contribution.
After I deployed the site, I realized there were 2 barely noticeable style issues on the API docs site.
1. The ASF dropdown menu only appears on the [home page of the docs site](https://lucenenet.apache.org/), not any of the other pages, like [Lucene.Net.Analysis.Common](https://lucenenet.apache.org/docs/4.8.0-beta00017/api/analysis-common/overview.html).
2. The breadcrumb menu used to begin with "API /" and then every breadcrumb would follow. But now the "API" part is on its own line and the rest of the breadcrumb appears below it. To see what I mean, compare [ArabicNormalizationFilterFactory on 4.8.0-beta00017](https://lucenenet.apache.org/docs/4.8.0-beta00017/api/analysis-common/Lucene.Net.Analysis.Ar.ArabicNormalizationFilterFactory.html) with [ArabicNormalizationFilterFactory on 4.8.0-beta00016](https://lucenenet.apache.org/docs/4.8.0-beta00016/api/analysis-common/Lucene.Net.Analysis.Ar.ArabicNormalizationFilterFactory.html).
Feel free to submit another PR to fix these, but as far as Apache is concerned we have fixed the ASF menu issue because it was only required on the home page of the main site.
The right menu is also missing from the 4.8.0-beta00017 docs (the part that indexes the current page), but I think that may be a docfx config issue instead of a style issue.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3477398110
@paulirwin
You probably need to do a CTRL + F5 to refresh your browser cache.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3361540211
I didn't mean to remove the page itself; just the link in the header. I don't think it needs that level of prominence.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3476747810
@NightOwl888 Am I missing something? I don't see the ASF menu on the homepage (https://lucenenet.apache.org/index.html), only on the beta 17 docs site.
Also note that there is an issue on Firefox where the top bar is covering up the right-hand side links:
<img width="2456" height="696" alt="screenshot-2025-11-01-at-13-57-06" src="https://github.com/user-attachments/assets/3656a7b7-fc24-4163-a39f-5a37504e85d5" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3361278016
> remove Download, if possible, since most people are probably using NuGet
An Apache release is *source code*, so these pages are required to download the official releases. The pre-built binaries and packages are technically only provided on NuGet for convenience (at least in Apache's eyes).
https://infra.apache.org/release-publishing.html#valid
That said, IIRC there is an official `.cgi` file that we could style that would dynamically show the releases on Apache's archives.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3473225164
@zka26 Thanks for the contribution!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3478101735
It says it already crawled it today:
```
Last crawl time: Sun, 02 Nov 2025 16:12:29 GMT over 219 websites.
```
So apparently the crawler is also unable to bust the cache. So, we either need to wait for the cache to expire or contact INFRA to have them force it. Let's see if the next crawl updates it first, though.
I also noticed that our "events" link doesn't match the regex that they supplied.
```
^https?://((www\.)?apache\.org/events/current-event|events\.apache\.org|www\.apachecon\.com/event-images/snippet\.js)
```
Oddly, the events page we linked to looks nicer than any of the pages in the regex. Maybe the docs are wrong on this, though.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "zka26 (via GitHub)" <gi...@apache.org>.
zka26 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3480300095
@NightOwl888 , @paulirwin Thank you for the review and for deploying,
- I realized I might have forgot to commit the `toc.yml` changes in the `apidocs`'s `toc` folder and that should be the culprit for the **missing ASF menu** on the other pages of the docs site.
- About the **breadcrumb split**ting, I think I might have an idea about it, I will check it out! (maybe a style that was meant only for the Site was left there, but I will find it out)
- I will reproduce the **Firefox issue** and fix it up, and try it on ome other browsers too, so we can be sure about it.
- As for the **event link**, I did bad, because I think, I just edited the URL itself and just appended the /events/ part. Since it landed me on an Apache event page, I did not double verified it in the regex. I will update it with the correct link as well in the toc.yml files.
Sorry about the issues, and thanks again for the heads-ups! If it is alright, then I will open a follow-up PR to address all the issues above!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "zka26 (via GitHub)" <gi...@apache.org>.
zka26 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3361575903
Thanks a lot for the detailed feedback and the examples! I would like to work on it and do it the right way, using drop-down approach in the header and try adjusting the menu layout while testing on smaller screen. I will work on that and update the PR accordingly and at the end we can see, if anything else needs to be done, more than glad to contribute! Thank you for the guidance again!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "zka26 (via GitHub)" <gi...@apache.org>.
zka26 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3471041353
The wrapping was restored and tried to fine tune the behaviors so they always respond good and clean at every width before transitioning either to the Desktop or the Mobile mode.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required footer links in doxfx.json [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3361246280
I do like the dropdown in the header, but I'm also okay with the footer for now.
The header is already wrapping on smaller resolutions, like the tablet I'm using now. If we do the header change, maybe we could move Contributing under Documentation, and Download under About (or remove Download, if possible, since most people are probably using NuGet).
But, I know this is a Hacktoberfest item, so I'm also cool with taking the quickest path to victory here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3478003230
Wow, that was aggressively cached. I had done that but it didn't work the first time. Great to see this is live!
However, the Whimsy checks are still failing as of this morning. We'll need to dig in to figure out why, but as long as we actually have the links there, at least we're meeting the requirement. Or, perhaps they are having a caching issue too that will eventually clear. https://whimsy.apache.org/site/project/lucenenet
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "NightOwl888 (via GitHub)" <gi...@apache.org>.
NightOwl888 commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3481356740
@zka26
Thanks. You are my hero.
I just noticed that the crawler code is available for inspection at: https://github.com/apache/whimsy/blob/master/tools/site-scan.rb. Maybe analyzing it (or using AI to analyze it against our home page source code) could shed some light on why nothing in the report is turning green. At the very least, we can confirm that the regex on the whimsy page is correct and the page we are linked to is not valid (which seems odd to me because I prefer the current page).
If that analysis doesn't reveal anything, let me know and I will contact INFRA to see if they can tell us why our site is not passing validation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Added ASF-required links using drop-down menu and unified navigation [lucenenet]
Posted by "paulirwin (via GitHub)" <gi...@apache.org>.
paulirwin commented on PR #1198:
URL: https://github.com/apache/lucenenet/pull/1198#issuecomment-3481361813
I found the problem (but not the cause, yet) of the caching issue: the `etag` returned has not changed between the old and new sites.
I fortunately had another browser instance still open that had the old cached version. Doing a normal load of the page was sending `If-None-Match` with etag value `"24f2-6428c36d87de9-gzip"`. (If you're unfamiliar, `If-None-Match` sends a previously returned `etag` value, to check if it matches. If it doesn't match, the server should return 200 OK with the updated contents along with a new `etag` header to update its cached value, and if it matches, that means the cached version is up to date so the server returns 304 Not Modified with an empty body.)
The server returned with a 304 Not Modified and also included the `etag` response header with the same value, which is interpreted by the browser as "the server confirmed that my cached version is correct". So this is not a client-side caching issue, this is actually the _server_ saying that the cached version is correct.
I then looked at what was happening in a browser that had the updated HTML/etc, and it was sending and receiving the exact same header value. So something is wrong on the server to where it's returning the same etag value even if the code has changed.
Note that the server does not send either an `Expires` header nor `Cache-Control` header with `max-age`, so effectively this cache may never expire since, according to the server, the `etag` value is exactly the same as before.
I am not sure why the server is returning the same `etag` value as before, as that is usually produced as effectively a hash of the contents of that page/resource, which should have changed with the updated HTML. If we are producing that etag and hardcoding it somewhere, we should fix that. Or perhaps this is an issue with the server infrastructure?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@lucenenet.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org