Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document apidocs update. Make table indicating which type of update needs which steps.

...

Code Block
languagebash
# You will be prompted for your Apache password
git push apache HEAD:master`

Publish Web Site Updates

If the change you are merging includes website or document updates, you should also update the project website. Look for files in the docs/ tree as well as some files in dcs/ and core/rest that affect documents.

For more info on documentation build, see Modifying Documents.

To publish the website:

...

There are three main types of content on the Apache Trafodion web site:

  • The main site content
  • Trafodion documents, generated from the Trafodion source code
  • Trafodion apidocs, generated from the Trafodion source code and built objects

Depending on which type of content you want to update, you will need to include different steps of the instructions shown below, required steps are marked with an X:

StepDescriptionCommandmaindocsapidocs
1Get the Trafodion source code from gitsee "Download and Install Source" XX
2Check out a specific release X.Y.Z, if you want to update content for a previous release
git checkout rel/X.Y.Z
 XX
3Build Trafodion documentation, after modifications to the documents, see Modifying Documents.
cd incubator-trafodion
source env.sh
mvn post-site 
 X 
4Build Trafodionsee "Build Source"  X
5Get the web site content from git
git clone https://ApacheUserName@git

...

-wip-us.apache.org/repos/asf/incubator-trafodion-site.git

...

cd incubator-trafodion-site

...


git checkout -b asf-site origin/asf-

...

site
XXX
6Make changes to main sitesee "Modify Web Site"X  
7Copy the built documentation from the Trafodion source tree to the site tree
cp -R incubator-trafodion/docs/target/*

...

   incubator-trafodion-site/
 X 
8Build apidocs (note: X.Y.Z is the release number, see step 2 above)
cd incubator-trafodion-site/

...

Once pushed, Apache gitpubsub takes care of populating http://incubator.trafodion.apache.org with your new changes. If they don’t show up, pushing another commit may work to trigger the automation. Just make an innocuous white-space change to some html file, commit it and push it.

apidocs
build_apidocs.sh -o X.Y.Z
  X
9Commit changes
git add --all
git commit 
XXX
10Push changes back to ASF repository
git push origin HEAD:asf-site
XXX
11Check that the website, http://trafodion.apache.org is refreshed. If it isn't, make a small white-space change to trigger the Apache gitpubsub that does the update. XXX
12
Once published, run https://validator.w3.org against http://trafodion.incubator.apache.org to ensure that there are no broken links

...

...

 

...

XXX
13Close the JIRA and/or pull request, if applicable XXX

...