This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne-website.git
The following commit(s) were added to refs/heads/master by this push:
new 064b77c65 tighter README
064b77c65 is described below
commit 064b77c659a7e6318f454fa18006dc34f26f3c9b
Author: Andrus Adamchik <[email protected]>
AuthorDate: Tue May 19 14:15:18 2026 -0400
tighter README
---
README.md | 34 +++++++++++++++++++++-------------
1 file changed, 21 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 8f5e802cd..b35c56eed 100644
--- a/README.md
+++ b/README.md
@@ -8,21 +8,27 @@ Contains sources of [Cayenne
website](http://cayenne.apache.org).
Just clone and run maven, nothing else required.
- git clone https://gitbox.apache.org/repos/asf/cayenne-website.git
- cd cayenne-website
- mvn
+```
+git clone https://gitbox.apache.org/repos/asf/cayenne-website.git
+cd cayenne-website
+mvn
+```
Open http://localhost:3000 in your browser. In dev mode site supports
live-reloading.
:grey_exclamation: _You can change host and port by setting `dev.host` and
`dev.port` properties:_
- mvn -Ddev.host="my.local" -Ddev.port="8080"
+```
+mvn -Ddev.host="my.local" -Ddev.port="8080"
+```
### Publish
To publish a new version just run Maven with `publish` profile. This will
build a production version of the site (with cayenne.apache.org base URL) and
push commit into `asf-site` branch that will be synced with actual site content
location:
- mvn -Ppublish -Dmsg="commit message describing site changes"
+```
+mvn -Ppublish -Dmsg="commit message describing site changes"
+```
That's all, so be careful and review your changes before publishing (also
don't forget to check them after).
@@ -41,12 +47,14 @@ You can use the following template:
`some-good-news.md`
- ---
- title: Good news everyone!
- date: 2017-01-01T00:00:00+03:00
- ---
-
- Content goes here
+```
+---
+title: Good news everyone!
+date: 2017-01-01T00:00:00+03:00
+---
+
+Content goes here
+```
#### Releasing new cayenne version
@@ -68,12 +76,12 @@ Usage:
* Update all docs after the release
```
- ./build-docs.sh 4.1.RC2
+./build-docs.sh 4.1.RC2
```
* Add fixes to the docs
```
- ./build-asciidocs.sh STABLE-4.0 4.0.2
+./build-asciidocs.sh STABLE-4.0 4.0.2
```
These scripts don't commit changes so you should commit them manually and
publish the site as usual.
