cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ntimof...@apache.org
Subject [cayenne-website] branch master updated: Add more info on docs update
Date Tue, 29 Oct 2019 12:23:22 GMT
This is an automated email from the ASF dual-hosted git repository.

ntimofeev 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 31b89da  Add more info on docs update
31b89da is described below

commit 31b89da73deecbe747904f2b20cebb9ae5038014
Author: Nikita Timofeev <stariy95@gmail.com>
AuthorDate: Tue Oct 29 15:23:14 2019 +0300

    Add more info on docs update
---
 README.md | 37 +++++++++++++++++++++++++++++--------
 1 file changed, 29 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 6cf546a..8f5e802 100644
--- a/README.md
+++ b/README.md
@@ -20,13 +20,13 @@ Open http://localhost:3000 in your browser. In dev mode site supports
live-reloa
 
 ### Publish
 
-To publish new version just run Maven with `publish` profile. This will build 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:
+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"
     
-That's all, so be carefull and review your changes before publishing (also don't forget to
check them after).
+That's all, so be careful and review your changes before publishing (also don't forget to
check them after).
 
-Don't forget to push you source's changes so others won't rewrite them.
+Don't forget to push your source's changes so others won't rewrite them.
 
 *NOTE*: This process can be automated by Jenkins. It can run publish on every commit to `master`.
 
@@ -37,7 +37,7 @@ Don't forget to push you source's changes so others won't rewrite them.
 #### Publishing news
 
 To publish news simply add new file at `src/main/site/content/news/` folder.
-You can use following template: 
+You can use the following template: 
 
 `some-good-news.md`
 
@@ -55,17 +55,38 @@ To update site content with information about new Cayenne version you
need to pe
 
 * Update data in `src/main/site/data/cayenne.yaml` file.
 * Write news (see information above).
-* Update documentation, this can be done with `build-docs.sh` script. 
-  You can run it like this: `./build-docs.sh 4.1.M2` 
+* Update documentation, see next section.
+  
+####  Update Cayenne Documentation
+
+There are two helpers shell scripts to update Cayenne documentation:
+
+* build-docs.sh that updates both JavaDoc and Asciidoc
+* build-asciidocs.sh that update Asciidoc only
+
+Usage:
+
+* Update all docs after the release
+```
+    ./build-docs.sh 4.1.RC2
+```
+    
+* Add fixes to the docs
+```
+    ./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. 
+
 
 ### Advanced 
 
-Node.js, Yarn, Gulp and Hugo used to build this site, Maven used just to boostrap Node.js
and Yarn tools and launch Gulp tasks.
+Node.js, Yarn, Gulp and Hugo tools are used to build this site, Maven used just to bootstrap
Node.js and Yarn tools and launch Gulp tasks.
 Hugo binaries managed by [hugo-bin](https://www.npmjs.com/package/hugo-bin) NPM module.
 
 #### Src structure
 
-There is two main parts of site src:
+There are two main parts of the site src:
 * `src/main/assets` assets processed by [Gulp](https://gulpjs.com) tasks
 
     * `/gulp/` - list of Gulp tasks


Mime
View raw message