Automated build of scribble documentation

[Gary Brown]

Hi

I've set up an automated build mechanism for the scribble
documentation. Currently it is intended to just work with
documentation placed in the scribble-docs git repo
(https://github.com/scribble/scribble-docs), although we may want to
consider whether the same approach should be used for the protocol
language specification (either in the separate repo or move the spec
to be in the scribble-docs repo as well).

Firstly if you navigate to the scribble-docs git repo link provided
above, it will take you to the 'code' part of the repository. The
source for the documentation in the repository is actually the wiki,
and therefore the only files in the code part is a short readme which
directs users to the wiki. So if you have a look at the wiki instead
(https://github.com/scribble/scribble-docs/wiki) it provides
instructions on how to build the documentation from the source
information provided on the wiki.

Currently there is the basic skeleton for a Protocol Language Guide -
which is intended to be a user friendly tutorial on how to write
scribble protocols. At present this only has a single chapter
(Overview). This has been created to demonstrate the documentation
process, and will gradually be fleshed out as the language spec
becomes stable.

Essentially the documentation process is:

1) Edit the content in the wiki or clone the wiki repo and edit the
asciidoc format files directly (for any significant change the second
approach is recommended).

2) Once the asciidoc tool is installed on your local system, and you
have cloned the wiki repo, then generate the docbook representation.

3) Commit the docbook representation back to the repo (after doing the
local maven build to check there are no errors).

4) Once changes are detected in the repo, a continuous integration job
running in jenkins (hosted by cloudbees.com) will also run the maven
build job and archive the latest successful build of the pdf. If there
are any errors detected, these should be notified to the user(s) who
applied the most recent commits.

5) The pdf is referenced from the scribble.org website (menu on the
right), so once the jenkins job has completed, the changed document
will be publicly available


So currently this will build the protocol language guide, but we can
include any common (i.e. implementation language independent)
documentation here. We may also decide we want the implementation
language specific documentation also included (and built) here?

Thoughts appreciated.

Regards
Gary

[Tiago Cogumbreiro]

Hello,

Just letting you know that the link for the PDF is down.

This is the error message:

Jenkins instance is Hibernated

This account is currently hibernated.

Regards,

Tiago

[Gary Brown]

Thanks for letting us know.

--
You received this message because you are subscribed to the Google Groups "scribble-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scribble-lan...@googlegroups.com.
To post to this group, send email to scribb...@googlegroups.com.
Visit this group at http://groups.google.com/group/scribble-lang.
For more options, visit https://groups.google.com/groups/opt_out.

[Gary Brown]

Hi Tiago

The protocol language guide was a work in progress, so does not actually contain much information at the moment - so I have removed the reference on the website for now until the document has been completed.

In the meantime, the language spec is available further down the page on the right - currently version 0.2, although a 0.3 version should be available in the near future.

Apologies for the inconvenience.

Regards

Gary