Skip to content

Commit 82785df

Browse files
peterabapeteraba
committed
Initial version
1 parent 11a9ce7 commit 82785df

39 files changed

+703
-18
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.idea
2+
resources/

‎LICENSE

+9-18
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,12 @@
1-
MIT License
1+
ISC License
22

3-
Copyright (c) 2020 Peter Aba
3+
Copyright 2020 Peter Aba
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
6+
provided that the above copyright notice and this permission notice appear in all copies.
117

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
8+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
9+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
10+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
11+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
12+
THIS SOFTWARE.

‎Makefile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
default: update
2+
3+
update:
4+
git submodule update --remote --merge
5+
6+
.PHONY: update

‎archetypes/default.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: true
5+
---
6+

‎config.toml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
baseURL = "https://docs.rdmp.app/"
2+
languageCode = "en-us"
3+
title = "Documentation for Roadmapper and rdmp.app"
4+
theme = "hugo-theme-learn"
5+
6+
[params]
7+
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
8+
# Useful to give opportunity to people to create merge request for your doc.
9+
# See the config.toml file from this documentation site to have an example.
10+
editURL = ""
11+
# Author of the site, will be used in meta information
12+
author = "Peter Aba"
13+
# Description of the site, will be used in meta information
14+
description = "Create presentable roadmaps in minutes"
15+
# Shows a checkmark for visited pages on the menu
16+
showVisitedLinks = false
17+
# Disable search function. It will hide search bar
18+
disableSearch = false
19+
# Javascript and CSS cache are automatically busted when new version of site is generated.
20+
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
21+
disableAssetsBusting = false
22+
# Set this to true to disable copy-to-clipboard button for inline code.
23+
disableInlineCopyToClipBoard = false
24+
# A title for shortcuts in menu is set by default. Set this to true to disable it.
25+
disableShortcutsTitle = false
26+
# When using mulitlingual website, disable the switch language button.
27+
disableLanguageSwitchingButton = true
28+
# Hide breadcrumbs in the header and only show the current page title
29+
disableBreadcrumb = false
30+
# Hide Next and Previous page buttons normally displayed full height beside content
31+
disableNextPrev = true
32+
# Order sections in menu by "weight" or "title". Default to "weight"
33+
ordersectionsby = "weight"
34+
# Change default color scheme with a variant one. Can be "red", "blue", "green".
35+
themeVariant = "mine"
36+
37+
[[menu.shortcuts]]
38+
name = "<i class='fas fa-external-link-square-alt'></i> rdmp.app"
39+
identifier = "r"
40+
url = "https://rdmp.app/"
41+
weight = 10
42+
43+
[[menu.shortcuts]]
44+
name = "<i class='fab fa-github'></i> Github repo"
45+
identifier = "gr"
46+
url = "https://github.com/peteraba/roadmapper"
47+
weight = 20

‎content/_index.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Content"
3+
description: "Build a roadmap in minutes, track progress like a pro"
4+
date: 2020-03-14T20:09:08+01:00
5+
chapter: false
6+
---
7+
8+
# Roadmapper
9+
10+
## Build a roadmap in minutes
11+
12+
1. Write your roadmap as a text file
13+
```none
14+
Initial development [2020-02-12, 2020-02-20]
15+
Bring website online
16+
Select and purchase domain [2020-02-04, 2020-02-25, 100%]
17+
Create server infrastructure [2020-02-25, 2020-02-25, 100%]
18+
Command line tool
19+
Create backend SVG generation [2020-03-03, 2020-03-10, 100%]
20+
Replace frontend SVG generation with backend [2020-03-08, 2020-03-12, 100%]
21+
Create documentation page [2020-03-13, 2020-03-31, 20%]
22+
Marketing
23+
Create facebook page [2020-03-17, 2020-03-25, 0%]
24+
Write blog posts [2020-03-17, 2020-03-31, 0%]
25+
Share blog post on social media [2020-03-17, 2020-03-31, 0%]
26+
Talk about the tool in relevant meetups [2020-04-01, 2020-06-15, 0]
27+
```
28+
29+
1. Save it (we'll use `roadmap.txt` as an example)
30+
31+
1. Convert it into an image
32+
33+
```
34+
roadmapper -i roadmap.txt -o roadmap.svg
35+
```
36+
37+
1. Benefit.
38+
39+
![Example roadmap as an SVG image](/images/roadmap.png "Example roadmap as an image")
40+
41+
## Track your progress like a pro
42+
43+
Use [git](https://git-scm.com/) or any other [version-control software](https://en.wikipedia.org/wiki/Comparison_of_version-control_software) to keep track of your changes. Since the generated SVG files tend to be pretty small, we recommend checking in both the text and image representation of your roadmap.
44+
45+
Alternatively you can also create some [word processor](https://en.wikipedia.org/wiki/Word_processor) document somewhere and inject your image into them. [Google Docs example](https://docs.google.com/document/d/1f0Y9-khN414V5Am6tsGtP1pF7a9U_zR35qHxtbFEKyw/edit?usp=sharing).
46+
47+
--------------------------------------
48+
49+
# [rdmp.app](https://rdmp.app)
50+
51+
## Build a roadmap in minutes
52+
53+
![screenshot of the roadmap form](/images/form.png "Fill out the form on https://rdmp.app")
54+
55+
## Track your progress like a pro
56+
57+
Every time you save your roadmap, it will get a new URL, save that URL so you never lose track of the historical view of your roadmap.
58+

‎content/about/_index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "About"
3+
date: 2020-03-14T19:28:11+01:00
4+
weight: 10
5+
chapter: true
6+
pre: "<b>I. </b>"
7+
---
8+
9+
### Chapter I
10+
11+
# About Roadmapper
12+
13+
Create presentable, trackable roadmaps in minutes.

‎content/about/rdmp.app.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "About rdmp.app"
3+
date: 2020-03-14T22:03:58+01:00
4+
chapter: false
5+
weight: 20
6+
---
7+
8+
[rdmp.app](https://rdmp.app) is a free to use, online service, based on the open source project [Roadmapper](https://github.com/peteraba/roadmapper).
9+
10+
Please note that while `rdmp.app` is free to use, it may converge from the open source offering, may be shut down, or may even introduce features not available in the open source versions without further notice.

‎content/about/roadmapper.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: "About Roadmapper"
3+
date: 2020-03-14T22:03:52+01:00
4+
chapter: false
5+
weight: 10
6+
---
7+
8+
[Roadmapper](https://github.com/peteraba/roadmapper) is an open source application designed to make it easy to create presentable and trackable roadmaps. It has two primary features:
9+
10+
1. It can be used as a command line tool to process text files and convert them into [SVG](https://www.w3.org/Graphics/SVG/) images.
11+
12+
2. It can be used to operate as a web service. It can be self-hosted, or there's an online version available under [rdmp.app](https://rdmp.app).
13+
14+
Please note that while `rdmp.app` is free to use, it may converge from the open source offering, may be shut down, or may even introduce features not available in the open source versions without further notice.

‎content/development/_index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Development"
3+
date: 2020-03-14T19:29:52+01:00
4+
weight: 50
5+
chapter: true
6+
pre: "<b>IV. </b>"
7+
---
8+
9+
### Chapter IV
10+
11+
# Roadmapper Development
12+
13+
![Official Golang Gopher](/images/golang.png "Roadmapper is a Golang application")

‎content/development/recommendations.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Recommendations"
3+
date: 2020-03-15T13:10:18+01:00
4+
weight: 10
5+
---
6+
7+
Here are the steps we recommend for development on [Roadmapper](https://github.com/peteraba/roadmapper).
8+
9+
10+
## Pre-requisite
11+
12+
1. [Install Git](https://git-scm.com/downloads).
13+
14+
1. [Install Go locally](https://golang.org/doc/install) for fast development loops.
15+
16+
1. Check out roadmapper: `git clone [email protected]:peteraba/roadmapper.git`
17+
18+
**Note:** Alternatively you can also download roadmapper from Github [following this link](https://github.com/peteraba/roadmapper/archive/master.zip).
19+
20+
21+
## Roadmapper CLI
22+
23+
To work on the cli you need nothing else then the above. You should be able to change the code to your liking and either build a new version with `make build` or just run `go run . c`.
24+
25+
Run `make test` to ensure your code did not break existing functionality.
26+
27+
If you'd prefer to have live feedback about your changes, you can install [air](https://github.com/cosmtrek/air) and start it in some dedicated terminal window.
28+
29+
30+
## Roadmapper web service
31+
32+
### Pre-requisite
33+
34+
1. [Install docker](https://docs.docker.com/install/).
35+
36+
1. [Install docker-compose](https://docs.docker.com/compose/install/).
37+
38+
39+
### Backend development
40+
41+
#### Pre-requisite
42+
43+
1. [Install Go locally](https://golang.org/doc/install) for fast development loops.
44+
45+
46+
1. Create your version of `docker-compose.yml` based on [our template](https://github.com/peteraba/roadmapper/blob/master/docker-compose-template.yml). Minimum set of changes:
47+
48+
1. Set a new database password:
49+
1. [Generate a new database password](https://passwordsgenerator.net/)
50+
1. Provide the new password in `docker-compose.yml`:
51+
- `services.db.environment.POSTGRES_PASSWORD`
52+
- `services.roadmapper.environment.DB_PASS`
53+
54+
1. Bring up your containers in the background: `docker-compose up -d`.
55+
56+
1. Start `air` providing a port and password: `DB_PORT={linked-db-port} DB_PASS={database-user} air`
57+
58+
59+
### Frontend development
60+
61+
Roadmapper frontend currently uses [bootstrap](https://getbootstrap.com/), but no JavaScript framework. On order to change anything, you should only need to change files inin the `static` directory.
62+
63+
If however you need to change the vendor libraries too, then you will need to change those in `display.go`, and you will need to rebuild `Roadmapper`.

‎content/development/technologies-used.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Technology Used"
3+
date: 2020-03-14T18:12:24+01:00
4+
weight: 20
5+
---
6+
7+
Please see our [special thanks](/special-thanks/technologies) page.

‎content/license/_index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "License"
3+
date: 2020-03-14T19:36:55+01:00
4+
weight: 60
5+
chapter: true
6+
pre: "<b>VI. </b>"
7+
---
8+
9+
### Chapter VI
10+
11+
# License
12+
13+
Learn more about the ISC License.

‎content/license/about-isc.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "About the ISC License"
3+
date: 2020-03-15T15:23:16+01:00
4+
---
5+
6+
The [ISC License](https://en.wikipedia.org/wiki/ISC_license) is a permissive free software license. In practice it is equivalent to the more famous [MIT License](https://en.wikipedia.org/wiki/MIT_License), but it is significantly shorter in length.
7+
8+
### Permissions
9+
10+
- Commercial use
11+
- Modification
12+
- Distribution
13+
- Private use
14+
15+
### Limitations
16+
17+
- Liability
18+
- Warranty
19+
20+
### Conditions
21+
22+
- License and copyright notice
23+
24+
## More information
25+
26+
You can find out more about the license on [its Wikipedia page](https://en.wikipedia.org/wiki/ISC_license).

‎content/privacy/_index.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Privacy"
3+
date: 2020-03-14T18:11:54+01:00
4+
weight: 60
5+
chapter: true
6+
pre: "<b>V. </b>"
7+
---
8+
9+
### Chapter V
10+
11+
# Privacy Policy
12+
13+
Roadmapper does not track you, [rdmp.app](https://rdmp.app) uses tools that do.

‎content/privacy/privacy-policy.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Privacy Policy"
3+
date: 2020-03-14T18:11:54+01:00
4+
weight: 10
5+
---
6+
7+
## Overview and our guidelines
8+
9+
The [original creator](https://peteraba.com) of [Roadmapper](https://github.com/peteraba/roadmapper) feels strongly about free software, freedom of choice and data privacy.
10+
11+
`Roadmapper` does not store personal information about you. While this is fundamentally true for [rdmp.app](https://rdmp.app) as well, it does use tools that track you to some extent.
12+
13+
Currently the only such tool is [Matomo](https://matomo.org/) (formerly Piwik), which we use as an alternative to Google Analytics. This helps us better understand how the tool is used, but it does not to track you across the web, only on domains associated with `rdmp.app`.
14+
15+
To support the project, `rdmp.app` may eventually display advertisements which will likely try to track you. Since your privacy is important for us, we will try to avoid tracking advertisements if possible, and we will be open about the technologies and services we use.
16+
17+
18+
### Using email addresses
19+
20+
If and when you provide an email address in any of our systems, it will be used to send you an email, then obfuscated and then stored. This means if you provide an email address like `[email protected]`, we will send the email you requested, then obfuscate the email address to something like `p**[email protected]`. We use this only to allow you to delete your old entries roadmaps if you want.
21+
22+
When you opt-in for storing your email address, it is actually stored in your browser by using a technology called [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). This technology enables us to prevent the sensitive information from traveling over the wire with every request. When you use a feature that can provide a better user experience with an email address provided, we will use JavaScript to automatically inject your email address into a field, which is never hidden. This means that you will always see a field pre-filled with your previously stored email address and you always get to remove it or change it.
23+
24+
As a consequence, you will have to re-fill your email address every time you use a new browser, even if you opted-in for storing your email address. We think it's a fair trade off for not sending your email address over the wire.
25+
26+
Providing an email address for your roadmaps is not strictly mandatory, but that is the only way to claim ownership and to be able to delete unneeded roadmaps later. If you do not provide an email address, you can only claim them as long as they are unclaimed. See more about this process under [support](/support/technical-support).
27+
28+
29+
### Data Collection
30+
31+
Roadmapper as a CLI application does not "phone home". It does not collect any data about you, and it never tries to communicate with some server over the wire.
32+
33+
When using Roadmapper as a service, all data services collecting data are opted out by default, although you may be able to enable some or all of the services used by `rdmp.app`.
34+
35+
`rdmp.app` uses [web analytics tools](https://en.wikipedia.org/wiki/Web_analytics) and will likely display advertisements using third-party tools which do track you. (This section will be updated once this happens.)
36+
37+
Service | Purpose | More info | Privacy policy
38+
--------|---------|-----------|---------------
39+
[Matomo](https://matomo.org/) (formerly Piwik) | [Web Analytics](https://en.wikipedia.org/wiki/Web_analytics) | [Wikipedia](https://en.wikipedia.org/wiki/Matomo_(software) | [link](https://policies.google.com/privacy)
40+
41+
42+
### Data Retention
43+
44+
When you run roadmapper on your own, data retention becomes your sole responsibility.
45+
46+
All data on `rdmp.app` will get deleted no later than 6 months after the last access. Since we do not store your personal data, you are not warned about this. Furthermore, we do not guarantee that your data will be available at any time after creation. We reserve the right to delete any data without prior warning.
47+
48+
49+
### Data Protection
50+
51+
While we do everything in our power to protect your data, we do not have the manpower to monitor all activities 24/7, therefore we do not make promises about they security of your data when using `rdmp.app`. Please ensure that you either run the software on your own, or that you only use our service with data that will not harm you in any way, should it get stolen, deleted or other way compromised.

0 commit comments

Comments
 (0)