November 29, 2019
At its core
TeamHub
is a simple idea – a static website for sharing knowledge and code
What is TeamHub
?
It centralizes code and documentation so that any team member can share code and docs in seconds. Website source files are created in a simple yet powerful and popular Markdown format, and are published as HTML, PDF and many other formats.
It works best when the source files with code and other content are synced with Git for version control. Thus at any point in time only one correct version of code & docs, the one commited on Git, is the single source of truth.
TeamHub
is powered by Hugo,
a popular open-source static site generator.
Markdown for documentation
Markdown, a popular markup language, is widely used for technical documentation. Millions of developers worldwide use Markdown for documentation management on GitHub, blogs, websites and alike.
The simplicity of Markdown stands out among other document formats. It takes an hour to learn how to edit text files with Markdown syntax, in contrast to the much steeper learning curve for LaTeX, for example. Unlike HTML/CSS, no tag editing is necessary to format the output.
RStudio + RMarkdown + Hugo
The RStudio Inc. company has taken Markdown format and Hugo a few steps further to create an effective documentation publishing platform. RMarkdown is a dialect of Markdown that combines executable code and narrative text into high quality reports, books, shiny applications, presentations, dashboards and many more. The beautiful simplicity is that the RStudio IDE is used both for creating the content and the Hugo-powered website where the content is published.
This entire website was built with Hugo + RMarkdown + RStudio. As well as these DS/ML textbooks.
Why use TeamHub
?
Keep knowledge growing – learning never stops
DS/ML and other IT teams need a single place to share their ongoing work –
code, technical documentation, tutorials, project memos and more – something
that will grow into a corporate learning environment where exchange of
knowledge is easy and simple.
TeamHub
ensures code versioning integrity, promotes code re-use,
makes it easy to share code & documentation, thus streamlining
company-wide DS/ML workflows.
When using R or Python, a data scientist simply uploads a Markdown file with executable code and comments with a button click. Publishing documents as HTML or PDF requires no special editing, and it takes seconds to make them available to every team member.
Hugo is fast and simple
Hugo is written in Go
language, carries no dependencies into
a working environment, builds hundred-page websites in seconds
and requires no or little HTML/CSS editing.
Hugo takes a source directory of files and uses these as input to create a complete website, without worrying about setting up complicated runtimes, dependencies and databases. Any team member can administer a Hugo-powered website.
Unlimited number of websites
Hugo is open-source and free. It can be used any number of times to build a corporate blog, a documentation repository, a single landing page or a website with thousands of pages.
How we deliver the TeamHub
We deploy the TeamHub
knowledgebase website on your servers,
using our favourite
Universal theme
or any other Hugo theme of your choice.
Tutorials and in-person 4-5 day training are provided so that your adminstrators are fully equipped to create Hugo-powered websites and extend them into documentation hubs. See a sample of our TeamHub tutorial.