Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

StepDescriptionCommandmaindocsapidocs
1Get the iota source code from gitsee Create Build Environment 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 iota documentation, after modifications to the documents, see Modifying Documents.
cd incubator-iota
source env.sh
mvn post-site 
 X 
4Build iotasee Build Source  X
5Get the web site content from git
git clone https://ApacheUserName@git-wip-us.apache.org/repos/asf/incubator-iota-site.git
cd incubator-iota-site
git checkout -b asf-site origin/asf-site
XXX
6Make changes to main sitesee Modify Web SiteX  
7Copy the built documentation from the iota source tree to the site tree
cp -R incubator-iota/docs/target/*   incubator-iota-site/
 X 
8Build apidocs (note: X.Y.Z is the release number, see step 2 above)
cd incubator-iota-site/apidocs
build_apidocs.sh -o X.Y.Z
  X
9Commit changes
git status
git add --all
git commit 
XXX
10Push changes back to ASF repository
git push origin HEAD:asf-site
XXX
11Check that the website, http://iota.apache.org is refreshed. If it isn't, make a small white-space change to trigger the Apache gitpubsub that does the update. XXX
12Once published, run https://validator.w3.org against updated pages to ensure that there are no broken links X  
13Close the JIRA and/or pull request, if applicable XXX