Skip to content

Add section numbers to docs and update publish scripts to update latest ... #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sgilda wants to merge 1 commit into from
Closed

Add section numbers to docs and update publish scripts to update latest ... #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/Windup-Core-Development-Guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
= Windup Core Development Guide

:toc:
:toclevels: 4
:toc: left
:toclevels: 5
:sectnumlevels: 5
:numbered:


== Overview

Expand Down
6 changes: 4 additions & 2 deletions docs/Windup-Rules-Development-Guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
= Windup Rules Development Guide

:toc:
:toclevels: 4
:toc: left
:toclevels: 5
:sectnumlevels: 5
:numbered:


== Overview
Expand Down
6 changes: 4 additions & 2 deletions docs/Windup-User-Guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
= Windup User Guide

:toc:
:toclevels: 4
:toc: left
:toclevels: 5
:sectnumlevels: 5
:numbered:


== Overview
Expand Down
640 changes: 320 additions & 320 deletions html/WindupCoreDevelopmentGuide.html
View file
Open in desktop

Large diffs are not rendered by default.

390 changes: 195 additions & 195 deletions html/WindupRulesDevelopmentGuide.html
View file
Open in desktop

Large diffs are not rendered by default.

154 changes: 77 additions & 77 deletions html/WindupUserGuide.html
View file
Open in desktop

Large diffs are not rendered by default.

27 changes: 23 additions & 4 deletions scripts/windupDocPublish.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
if [ "$1" == "" ] || [ "$2" == "" ] || [ "$3" == "" ]; then

echo "You must pass the following arguments on the command line:"
echo " Path to the local windup-documentation GitHub directory"
echo " Path to the local windup source GitHub directory"
echo " Name of the new beta version"
echo " arg 1: Path to the local windup-documentation GitHub directory"
echo " arg 2: Path to the local windup source GitHub directory"
echo " arg 3: New documentation version"
echo "For example:"
echo " scripts/windupDocPublish.sh ~/GitRepos/windup-documentation/ ~/GitRepos/windup/ 2.0.0.Beta8"
echo " scripts/windupDocPublish.sh ~/GitRepos/windup-documentation/ ~/GitRepos/windup/ 2.0.0.Final"
exit
else
echo "Windup Documentation will be copied from here: " $1
Expand Down Expand Up @@ -54,6 +54,13 @@ echo " git push origin HEAD"
echo " (issue a pull and verify)"
echo " git push upstream gh-pages"
echo " firefox http://windup.github.io/windup/docs/$WINDUP_VERSION/html/WindupUserGuide.html"
echo " unlink latest"
echo " ln -s $3 latest"
echo " git add latest"
echo " git commit -m 'Replace symlink for latest to point to 2.0.0.Final'"
echo " git push origin HEAD"
echo " (issue a pull and verify)"
echo " git push upstream gh-pages"

# git push origin HEAD
## issue a pull and verify
Expand All @@ -62,3 +69,15 @@ echo " firefox http://windup.github.io/windup/docs/$WINDUP_VERSION/html/Windu

cd $1

## Update the symlink to point to the latest docs
# cd $2/docs
# unlink latest
# ln -s $3 latest
## for example: ln -s 2.0.0.Final latest
# git add latest
# git commit -m 'Replace symlink for latest to point to 2.0.0.Final'
# git push origin HEAD
## issuw a pull and verify
# git push upstream gh-pages