{"id":17536265,"url":"https://github.com/apache/lucene-site","last_synced_at":"2025-09-06T08:48:11.522Z","repository":{"id":35800767,"uuid":"215638242","full_name":"apache/lucene-site","owner":"apache","description":"Apache Lucene website","archived":false,"fork":false,"pushed_at":"2025-04-10T10:09:04.000Z","size":71144,"stargazers_count":6,"open_issues_count":3,"forks_count":27,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-04-10T10:51:20.255Z","etag":null,"topics":["apache","lucene","pelican","website"],"latest_commit_sha":null,"homepage":"https://lucene.apache.org/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-16T20:26:33.000Z","updated_at":"2025-04-10T10:07:37.000Z","dependencies_parsed_at":"2023-02-19T19:30:36.295Z","dependency_job_id":"fdaa0e11-2143-469d-b183-6ba38b91f863","html_url":"https://github.com/apache/lucene-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Flucene-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Flucene-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Flucene-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Flucene-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/lucene-site/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248662196,"owners_count":21141526,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache","lucene","pelican","website"],"created_at":"2024-10-20T20:00:34.570Z","updated_at":"2025-04-15T04:33:17.066Z","avatar_url":"https://github.com/apache.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Website for Apache Lucene\n\nThis repository contains the \"source code\" of the Lucene website at [lucene.apache.org](https://lucene.apache.org/).\n\n**NOTE:** The Apache [Solr website](https://solr.apache.org/) now has [its own git repository](https://github.com/apache/solr-site).\n\n## Building the site\n\nThe site is written in [Markdown][9] syntax and built into a static site using [Pelican][1]. The site is re-built automatically by [ASF Buildbot][5] on every push to main branch and the result can be previewed at [lucene.staged.apache.org][6]. Build success/failure emails are sent to [commits@lucene.apache.org][7] mailing list. Read more about the mechanics behind auto building in [INFRA Confluence][8].\n\n\nIf the staged site looks good, simply merge the changes to branch `production` and the site will be deployed in a minute or two. Note that simple edits can also be done directly in the GitHub UI rather than clone -\u003e edit -\u003e commit -\u003e push.\n\n\u003e **IMPORTANT**: Please never commit directly to `production` branch. All commits should go to main, and then merge main to production. Note that it **is** possible to make a Pull Request for the merge from `main--\u003eproduction`. If you do so, please merge using a merge commit rather than a squash merge.\n\nFor larger edits it is recommended to build and preview the site locally. This lets you see the result of your changes instantly without committing anything. The next sections detail that procedure. The TL;DR instructions goes like this:\n\n    # Usage: ./build.sh [-l] [\u003cother pelican arguments\u003e]\n    #        -l     Live build and reload source changes on localhost:8000\n    #        --help Show full help for options that Pelican accepts\n    ./build.sh -l\n\nNow go to \u003chttp://localhost:8000\u003e to view the beautiful Lucene web page served from your laptop with live-preview of updates :)\n\n### Installing Pelican by hand\n\nThe site uses [Pelican][1] for static html generation. Pelican requires [Python 3.5+][4] and can be installed with pip.\n\n**The `build.sh` script mentioned in the above paragraph takes care of setting up your Pelican environment,** and you can skip this part unless you want to understand the moving parts and install things by hand. Assuming that you have python3 installed, simply run:\n\n```sh\npip3 install -r requirements.txt\n```\n\nIf you run into conflicts with existing packages, a solution is to use a virtual Python environment. See the [Pelican installation page][2] for more details. These are quick commands, Linux flavor:\n\n```sh\npython3 -m venv env\nsource env/bin/activate\npip install -r requirements.txt\n```\n\nOnce Pelican is installed you can convert your content into HTML via the pelican command (`content` is the default location to build from).\n\n```sh\npelican\n```\n\nThe above command will generate your site and save it in the `output/` folder using the lucene theme and settings defined in `pelicanconf.py`\n\nYou can also tell Pelican to watch for your modifications, instead of manually re-running it every time you want to see your changes. To enable this, run the pelican command with the `-r` or `--autoreload` option. On non-Windows environments, this option can also be combined with the `-l` or `--listen` option to simultaneously both auto-regenerate and serve the output through a builtin webserver on \u003chttp://localhost:8000\u003e.\n\n```sh\npelican --autoreload --listen\n```\n\nRemember that on Mac/Linux you can use the `build.sh` script with `-l` option to do the same.\n\n## Updating site during a Lucene release\n\nThe release manager documentation will contain detailed instructions on how to update the site during a release. Some of the boring version number update and download link generation is handled by Pelican, see below.\n\nJavaDoc publishing is **not** done through this repo, but in SVN as detailed in Release Manager instructions, and will then appear in respective sections of the website automatically, see `.htaccess` for how.\n\n### Bump Lucene latest version after the release\n\nThere are variables in **pelicanconf.py** to modify the latest 2 supported release versions. This will affect all references to release version in the theme, but not in pages or articles. Pelican views pages and articles as static write-once, like a blog post, whereas the theme can be more dynamic and change with every build.\n\nModify `LUCENE_LATEST_RELEASE` and `LUCENE_PREVIOUS_MAJOR_RELEASE`, and\n`LUCENE_LATEST_RELEASE_DATE` to affect\n\n* Full patch release versions in html such as \"6.3.0\".\n* Minor release versions in html such as \"6.3.x\".\n* Links to source, javadocs, PGP, and SHA512 which use underscores to separate\n  version parts such as `6_3_0`\n* References to the release date of the latest version which can be dynamically\n  formatted for different pages.\n\n[1]: https://blog.getpelican.com/\n[2]: https://docs.getpelican.com/en/stable/install.html\n[4]: https://www.python.org/downloads/\n[5]: https://ci2.apache.org/#/builders/3\n[6]: https://lucene.staged.apache.org\n[7]: https://lists.apache.org/list.html?commits@lucene.apache.org\n[8]: https://wiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories\n[9]: http://daringfireball.net/projects/markdown/syntax\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Flucene-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Flucene-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Flucene-site/lists"}