How does the blog setup and publishing work # Before I forget, here is how the current configuration works.
There are two repositories at play:
source repo - https://github.com/miroadamy/miroadamy.com github pages repo (== GHPR) - https://github.com/miroadamy/miroadamy.github.io The blog source repo contains only source files (.md, static media etc). This repo has usual submodules under the /themes - e.g. /themes/even which is one currently used.
I have decided to consolidate all piecemeal versions of my blogpost uder one roof and at the same to do these four things
technology upgrade - from Jekyll to Hugo visual refresh of the page review tagging and categorization merge hidden posts from Wikis to one place Why Hugo replaced Jekyll # The version 3 of my blog (see below for a bit of history) has been hosted on Github pages and using the default static site generators - Jekyll.
both Wikis are backed by Git repo both allow local edit Gollum # See https://github.com/github/gollum#readme
Installation: http://alblue.bandlem.com/2011/05/git-tip-of-week-gollum.html
sudo gem install gollum
Running # git init TestWiki gollum --page-file-dir wiki TestWiki openurl http://localhost:4567 Parsers - separate install # gem install rdiscount gem install wikicloth Get Wiki for repo # git clone URL URL: - git@github.com:radegast/dotvim.wiki.git R+W - https://radegast@github.com/radegast/dotvim.wiki.git R+W - git://github.com/radegast/dotvim.wiki.git R Pros # multiple markups supports Markdown List of all pages Questions # How to link to page in subdir
GraphViz # installed from package See http://www.graphviz.org/ Radegast:diagrams miro$ dot -V dot - graphviz version 2.28.0 (20110509.1545) Radegast:diagrams miro$ which dot dot is /usr/local/bin/dot SchemaSpy # installed in /opt/diagrams see http://schemaspy.sourceforge.net/ Radegast:schemaSpy miro$ java -jar ./schemaSpy_5.0.0.jar -cp .:/Users/miro/lib/java/jdbc/mysql-connector-java-5.1.7-bin.jar -t mysql -o library -host localhost -u twt_dX_core -db twt_dX_core -p twt_dX_core Using database properties: [./schemaSpy_5.0.0.jar]/net/sourceforge/schemaspy/dbTypes/mysql.properties Gathering schema details....................................................................................................................................................................................................................................................................................................................................................(36sec) Writing/graphing summary..... .......(353sec) Writing/diagramming details.................................................................................................................................................................................................................................................................................................................................................(104sec) Wrote relationship details of 337 tables/views to directory 'library' in 494 seconds. View the results by opening library/index.html Radegast:schemaSpy miro$ Radegast:schemaSpy miro$ ll total 904 PlantUML # installed in /opt/diagrams manual is attached: PlantUML Language Reference Guide.pdf See http://plantuml.sourceforge.net/classes.html in /opt/plantUML-DEMO/ there are sample files @startuml img/sequence_img009.png Alice -> Bob: Authentication Request alt successful case Bob -> Alice: Authentication Accepted else some kind of failure Bob -> Alice: Authentication Failure group My own label Alice -> Log : Log attack start loop 1000 times Alice -> Bob: DNS Attack end Alice -> Log : Log attack end end else Another type of failure Bob -> Alice: Please repeat end @enduml
Even with having Wiki as the main documentation repository, not all documentation ends up in a Wiki. Some documentation needs to be managed as part of the source tree - e.g. Readme's, compilation instructions and similar. This information is usually either plain text or in some form of text processor format, mostly Microsoft Word compatible. Both have their selection of problems. Word documents are large, bloated, harder to version controlled and not readable in shell environment (try to cat or tail Word document :-)). The plain text format lacks visual structure and without headlines, bold/italic, font sizes etc is harder read.