Sha256: bc08c816aa5f0a007f39511ae4a73fa7087c5a77a6639c60bd621caa3309b9a6

Contents?: true

Size: 1.11 KB

Versions: 11

Compression:

Stored size: 1.11 KB

Contents

@startuml
!theme cerulean-outline
' !theme spacelab
hide footbox
autonumber

title "Generate docs via GitHub web hook"

box "GitHub" #EEEEEE
actor       Editor       as Ed
participant GitHub       as GitHub
end box

box "Document Hosting Server" #EEEEEE
participant "Web Server" as Webserv
participant "Passenger"   as Pass
participant "Document\nGenerator"   as Docgen
note right of Docgen
  This could be
  a sinatra-based
  application that 
  use giblish' helper
  classes.
end note
end box


Ed -> GitHub     : push doc update\nto repository
GitHub -> Webserv : send POST request
Webserv -> Pass : hand over\nPOST request
Pass -> Docgen : hand over\nPOST request
Docgen -> Docgen : generate\ndocumentation
note left
  The documents are generated and stored\n
  somewhere in the file system known to\n
  the web server.
end note
/' You can also declare:

== Using raw git hook ==

Ed -> GitHub     : push doc update to repository
GitHub -> Web server : send POST request
Webserv -> Pass : hand over POST request to passenger
Pass -> Docgen : hand over POST request to Sinatra
Docgen -> Docgen : generate documentation
  '/

@enduml


Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
giblish-2.2.2 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.2.1 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.2.0 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.1.2 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.1.1 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.1.0 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.0.1 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.0.0 docs/howtos/setup_static_site_assets/docgen_github.puml
giblish-2.0.0.pre.alpha1 docs/howtos/trigger_generation_im/docgen_github.puml
giblish-1.0.0 docs/howtos/trigger_generation_im/docgen_github.puml
giblish-1.0.0.rc2 docs/howtos/trigger_generation_im/docgen_github.puml