[
https://issues.apache.org/jira/browse/TIKA-4632?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18053999#comment-18053999
]
ASF GitHub Bot commented on TIKA-4632:
--------------------------------------
tballison opened a new pull request, #2550:
URL: https://github.com/apache/tika/pull/2550
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for your contribution to [Apache Tika](https://tika.apache.org/)!
Your help is appreciated!
Before opening the pull request, please verify that
* there is an open issue on the [Tika issue
tracker](https://issues.apache.org/jira/projects/TIKA) which describes the
problem or the improvement. We cannot accept pull requests without an issue
because the change wouldn't be listed in the release notes.
* the issue ID (`TIKA-XXXX`)
- is referenced in the title of the pull request
- and placed in front of your commit messages surrounded by square
brackets (`[TIKA-XXXX] Issue or pull request title`)
* commits are squashed into a single one (or few commits for larger changes)
* Tika is successfully built and unit tests pass by running `mvn clean test`
* there should be no conflicts when merging the pull request branch into the
*recent* `main` branch. If there are conflicts, please try to rebase the pull
request branch on top of a freshly pulled `main` branch
* if you add new module that downstream users will depend upon add it to
relevant group in `tika-bom/pom.xml`.
We will be able to faster integrate your pull request if these conditions
are met. If you have any questions how to fix your problem or about using Tika
in general, please sign up for the [Tika mailing
list](http://tika.apache.org/mail-lists.html). Thanks!
> Experiment with Antora for publishing adocs in 4.x
> --------------------------------------------------
>
> Key: TIKA-4632
> URL: https://issues.apache.org/jira/browse/TIKA-4632
> Project: Tika
> Issue Type: Task
> Reporter: Tim Allison
> Priority: Minor
>
> I merged the .adocs from TIKA-4625. Claude recommended antora, which is used
> by Solr (e.g. https://solr.apache.org/guide/solr/latest/index.html) and a few
> other ASF projects for converting those to static html.
> Antora will give us site search and will allow for "living documentation" -
> where we have json in tests/examples that we have unit tests against, that is
> then imported directly into the documentation.
> We can have multiple versions as the Solr manual has that are tied to
> specific branches, e.g. "docs/4.0.1", which would allow updates for the 4.0.1
> documentation, etc.
> There's a lot still to do, but I think this makes sense.
> My proposal would be to continue with our current site for 3.x, build with
> antora for 4.x and then cp the target/site from antora to our site's
> target/site/4.x directory and publish. Once 3.x is EOL'd we can switch over
> to move to antora.
> Or, maybe we switch over shortly after the 4.x release, with a link to
> tika.apache.org/3.x.
> To build this and see what it looks like, I quote Claude and the directions
> that it generated on our Maintainers/Publishing the Site page. LOL
> Options 2 and 3 are far better than option 1. I'll update that shortly.
> {noformat}
> To build the documentation locally:
> cd docs
> mvn antora:antora
> The generated site will be at docs/target/site/.
> Previewing the Site
> Option 1: Open directly in browser
> # Linux
> xdg-open docs/target/site/index.html
> # macOS
> open docs/target/site/index.html
> # Windows
> start docs/target/site/index.html
> Option 2: Python HTTP server (recommended for testing search and links)
> cd docs/target/site
> python3 -m http.server 8000
> Then open http://localhost:8000 in your browser.
> Option 3: Node.js HTTP server
> npx http-server docs/target/site -p 8000
> Then open http://localhost:8000 in your browser.
> {noformat}
> cc [~dep4b], who may have some experience with Antora on Solr?
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
