Add Roadmap to documentation repo

DashboardHub / PipelineDashboard

Dashboard for your Deployment pipeline https://dashboardhub.io/

https://pipeline.dashboardhub.io/

GNU General Public License v3.0

152 stars 43 forks source link

Add Roadmap to documentation repo #1077

Closed eddiejaoude closed 5 years ago

eddiejaoude commented 5 years ago

Similar to these examples https://twitter.com/geekygirldawn/status/1062373551003590657

eddiejaoude commented 5 years ago

Could use AsciiDoctor diagrams, for example http://blockdiag.com/en/nwdiag/nwdiag-examples.html

eddiejaoude commented 5 years ago

Road map

version	date	title	description
v0.11.5	31st May 2019	AWS to Firebase	realtime dashboard updates
v0.11.6	31st June 2019	Monitoring	monitor all your deploy environments
v0.11.9	14th Sept 2019	Web Engineering	DashboardHub supporting Weuceu

Diagram... https://mermaidjs.github.io

| version | date | title | description |
| :--- | :--- | :--- | :--- |
| v0.11.5 | 31st May 2019 | AWS to Firebase | realtime dashboard updates |
| v0.11.6 | 31st June 2019 | Monitoring | monitor all your deploy environments |
| v0.11.9 | 14th Sept 2019 | Web Engineering | DashboardHub supporting Weuceu |

csengep commented 5 years ago

Image from iOS (2)

aimed for a flow chart look
version, date and title included
more details available as you click on the boxes

Next step:

will draw up examples of what can be made through mermaid

eddiejaoude commented 5 years ago

Another option is something like this, but without the cloud, what do you think? http://blockdiag.com/en/nwdiag/nwdiag-examples.html#peer-networks

eddiejaoude commented 5 years ago

I had a quick play with blockdiag and it seems a bit of a pain, better to stick with mermaid 👍

csengep commented 5 years ago

https://mermaidjs.github.io/flowchart.html https://mermaidjs.github.io/gantt.html

I think one of these two would be appropriate, any preferences?

A Flowchart looks cleaner and it is really easy to understand but a Gantt diagram might be more appropriate if more information on the projects is to be included, like start and finish dates and summaries of elements of the project.

eddiejaoude commented 5 years ago

I really prefer the Gant chart (especially the 2nd one with the extra text). I can also help if you need too 🤓

csengep commented 5 years ago

gantt
    title DashboardHub RoadMap
    dateFormat  YYYY-MM-DD
    section Version 11.5
    Real Time Events           :a1, 2019-05, 30d
    Open Source Contributions     :after a1  , 20d
    section Version 11.6
    Task in sec      :2019-06, 6d
    another task      : 20d
    section Version 11.7
    Task in sec      :2019-07, 15d
    another task      : 24d
    extra task     : 24d
    section Version 11.8
    Task in sec      :2019-08, 20d
    another task      : 28d

Screen Shot 2019-06-02 at 13 40 52

not sure how to get the dates on the bottom right, will work that out later

eddiejaoude commented 5 years ago

Looks great 👍

eddiejaoude commented 5 years ago

I am going to leave in review until we add to the documentation repo - I think you will need my input on dates first though

eddiejaoude commented 5 years ago

With real data:

gantt
    title DashboardHub RoadMap 2019
    dateFormat DD-MM-YY

    section Version 11.6
    Monitors :active, monitors, 20d

    section Version 11.7
    Webhooks :crit, webhooks, 30d
    Deployments :deployments, after monitors, 10d

    section Version 11.8
    Project dashboard :dashboard, after deployments, 10d