...
Step | main | docs | apidocs | Description | Command |
---|---|---|---|---|---|
1 | X | X | X | Get the Trafodion source code from git | see "Download and Install Source" |
2 | X | X | Check out a specific release X.Y.Z, if you want to update the documentation for a previous release | git checkout rel/X.Y.Z | |
3 | X | X | Build Trafodion site & documentation, after modifications to the documents, see Modifying Documents. | cd trafodion | |
4 | X | Build Trafodion | see "Build Source" | ||
5 | X | X | X | Get the web site content from git | git clone https://ApacheUserName@gitbox.apache.org/repos/asf/trafodion-site.git |
6 | X | X | Copy built web/doc changes to main site. This should be done from the master branch (release branch while a release is in progress) ONLY. This should not over-write release-specific docs. | cp -R trafodion/docs/target/* trafodion-site/ | |
7 | X | Copy the release-specific built documentation. This is for non-master branches. | cp -R trafodion/docs/target/docs/<release> trafodion-site/docs/ | ||
8 | X | Build apidocs (note: X.Y.Z is the release number, see step 2 above). TBD: Instructions for copying apidocs to site repository. | cd trafodion-site/apidocs | ||
9 | X | X | X | Commit changes in the web site repository | git status |
10 | X | X | X | Push changes back to ASF repository | git push origin HEAD:asf-site |
11 | X | X | X | Check that the website, http https://trafodion.apache.org is refreshed. If it isn't, make a small white-space change to the index.html file to trigger the Apache gitpubsub that does the update. | |
12 | X | Once published, run https://validator.w3.org against updated pages to ensure that there are no broken links | |||
13 | X | X | X | Close the JIRA and/or pull request, if applicable |
...