datastation-documentation VS docsify

Hey folks! I quit my job at Oracle almost a year ago now to build DataStation. It's an app I've wanted as an engineering manager for years now.

DataStation helps you query a variety of data sources (conventional SQL like PostgreSQL and MySQL, non-SQL like Prometheus or Elasticsearch), files and HTTP APIs. It is not a SQL layer on top of these various APIs like FDW in Postgres or Apache Calcite. For Prometheus you query with PromQL. For Elasticsearch you query with Lucene. And for SQL databases you query with their SQL dialect.

DataStation is made of panels (other apps might call them cells) that each produce a result. Panels can refer to other panels. These allow you to build workflows that cross the boundary of a particular datasource. For example you might have some data in a CSV a product manager gave you and the bulk of your data is in PostgreSQL. DataStation helps you pull together these data sets and script them.

DataStation is mainly a desktop app today where the end result is that you export graph SVGS or HTML tables or markdown tables or just a CSV file. All this data stays on your laptop so it's as easy to use in a corporate environment as any existing SQL IDE or Jupyter Notebook.

In the last year it's reached 1.5k stars on Github, over 1000 unique users and currently on-average about 40 fairly active users per month (defined as having opened the app more than a few times).

DataStation is primarily an Electron app but the code that evaluates panels is written in Go.

You can find a ton of tutorials on how to interact with supported databases on the DataStation website: https://datastation.multiprocess.io/docs/.

Looking forward to your feedback!

There are primarily a bunch of tutorials for getting started [0] (these are up to date) and some old videos (not up to date) [1].

[0] https://datastation.multiprocess.io/docs/

[1] https://www.youtube.com/channel/UCGOQFKonPUVo5LgxQDW26yg/vid...

A markdown generator embeds markdown from a Github repo into the marketing site. This way the marketing site is kept private while anyone can easily contribute to docs.

Docs are kept in separate folders for each release.

https://github.com/multiprocessio/datastation-documentation

Docsify is frequently updated; the latest release was on June 24, 2023, and the most recent update was on December 17, 2023. It is MIT-licensed and has an active Discord community.

okay new plan, does anyone know how to do this docsify on github? i obviously am a noob on github and recently on reddit. I'd like to help where i can but my knowlegde seems to be my handycap. i could provide you a trash-mail, if you need one, but i need a PO (product owner) to manage the git... i have no clue about this yet (pages and functions and stuff)

The tools to author it aren't that important, frankly. Ask your audience what they're most comfortable using and try to meet them there.

If the stakeholders are technical, you have more options. If they aren't, I hope you like Google Docs or Word, because if you give them anything other than that or a PDF, they'll probably complain. At worst, yeah, write it in a long Markdown text file and use tools like pandoc to transform that into other formats as needed.

If you do need a website and you're not generating enterprise-scale amounts of content (and it sounds like you're not) try things that let you avoid needing build steps and infrastructure if at all possible, so you can iterate and deploy changes with as little friction as you can.

Tools like Docsify[1] can take a pile of Markdown files and serve a site out of them, client- or server-side, without a static build step. Depending on the org, you can get away with GitHub's default rendering of Markdown in a repo. Most static site builds for stuff your scale are overengineered instances of premature optimization.

Past those initial hurdles, the format and tools challenges are all in maintenance. How can you:

- most easily keep the content up to date

- delegate updates as the staff grows or changes

- proactively distribute updates ASAP to the people who'd most benefit from receiving them

That's going to depend a lot more on who'll contribute updates, what their technical proficiency's like, and how they prefer to communicate. It might be a shared git repo and RSS or Slack notifications if they're comfortable with those things, and it might be a Google Doc and email if they're like most non-technical stakeholders.

1: https://docsify.js.org

Big fan of https://docsify.js.org since theres no need to compile your static site. A small amount of js just renders markdown.

If you are searching for examples of an arbitrary Jellyfin support site, visit https://travisflix.com/help/#/support (or help.travisflix.com which redirects to the /help/ URI of the TLD) to take a look at what I have done with docsify on Github Pages.

*Leantime - Competitor to OP? Updated recently, uses Docsify, no demo :(

There are a lot of open-source projects that can help businesses to save time and money. For example, we created a Free Admin panel a few months ago https://github.com/altence/lightence-admin That's an example of free documentation generator https://github.com/docsifyjs/docsify There are a lot more examples. And I want to find an idea of some similar generic solutions that can help various types of businesses