...
Code Block | ||
---|---|---|
| ||
# 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:
Step | Description | Command | main | docs | apidocs |
---|---|---|---|---|---|
1 | Get the Trafodion source code from git | see "Download and Install Source" | X | X | |
2 | Check out a specific release X.Y.Z, if you want to update content for a previous release | git checkout rel/X.Y.Z | X | X | |
3 | Build Trafodion documentation, after modifications to the documents, see Modifying Documents. | cd incubator-trafodion | X | ||
4 | Build Trafodion | see "Build Source" | X | ||
5 | Get 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 |
...
|
...
site | X | X | X | ||
6 | Make changes to main site | see "Modify Web Site" | X | ||
7 | Copy the built documentation from the Trafodion source tree to the site tree | cp -R incubator-trafodion/docs/target/* |
...
incubator-trafodion-site/ | X | ||
8 | Build 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 | X | ||||
9 | Commit changes | git add --all | X | X | X |
10 | Push changes back to ASF repository | git push origin HEAD:asf-site | X | X | X |
11 | Check 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. | X | X | X | |
12 |
Once published, run https://validator.w3.org against http://trafodion.incubator.apache.org to ensure that there are no broken links |
...
...
...
X | X | X | |||
13 | Close the JIRA and/or pull request, if applicable | X | X | X |
...