= Updating the Website

:Notice: 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.
:page-partial:

As part of the release process we xref:post-release-successful.adoc#generate-website[generate] and publish the website.
An (intentional) side-effect of this process is to create a branch for the release (that is, `{page-causewayrel}`).
This branch can then be used for documentation updates.

== Update docs

Prereqs:

* jdk 11
* mvn 3.x
* groovy 3.x
* pandoc 2.x
* dos2unix

In the regular `causeway` repo:

* Check out the branch:
+
[source,bash,subs="attributes+"]
----
git checkout {page-causewayrel}
----

* make documentation updates, and commit changes

* make sure the tooling is built:
+
[source,bash,subs="attributes+"]
----
mvn -D module-tooling -D skip.essential install -DskipTests
----

* generate the website:
+
[source,bash,subs="attributes+"]
----
sh preview.sh
----
+
[NOTE]
====
This now runs updates the config properties automatically (unless suppressed by a flag)

[source,bash,subs="attributes+"]
----
mvn clean install -pl core/config
----
====

This updated website is written to `antora/target/site`; we'll use the results in the xref:#publish-website[next section].




include::partial$publish-and-index-website.adoc[]

