Skip to content
This repository was archived by the owner on Dec 9, 2023. It is now read-only.

Commit 3d342cc

Browse files
Phantas0sPhantas0s
committed
Writing README
1 parent 8ea2e91 commit 3d342cc

File tree

1 file changed

+39
-20
lines changed

1 file changed

+39
-20
lines changed

‎README-PREPAR.md‎

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,13 @@ Since a diagram is better than a wall of text, here we go:
130130
@startuml
131131

132132
general : Global configuration of your dashboard
133-
projects : List of your project
133+
projects : List of your projects
134134
services: Configurations of every services you want to use
135-
widgets: List of widgets you want to display.
135+
widgets: List of widgets you want to display
136136
row: Create a row which contains columns
137137
col: Create a column which contains widgets
138138
size: Size of the column (T-shirt sizes or number 0-12)
139-
elements: Your actual widgets and their configuration
139+
elements: Your actual widgets and their configuration for the current column
140140

141141

142142
general-->projects
@@ -154,8 +154,8 @@ col--->elements
154154
There are three category of widgets:
155155

156156
* `box` - a single value in a box
157-
* `bar` - a bar diagram with multiple values overtime
158-
* `table` - data in a tabble
157+
* `bar` - a bar diagram with multiple values overtime (dates on the x-axis)
158+
* `table` - data in a table
159159

160160

161161
# Configuration reference
@@ -183,7 +183,7 @@ None.
183183
##### Display Options
184184

185185
| Name | Description | Default value | Examples |
186-
| ---------------- | - | ----------------- | ------------------------------- |
186+
| ---------------- | -- | ----------------- | ------------------------------- |
187187
| title | Title | Depending on the widget | ` Users ` |
188188
| height | Height | `10` | `5` |
189189
| title_color | Title color | `Default color` | `yellow`, `red` (see [colors](#colors)) |
@@ -254,7 +254,7 @@ Here's the list of every widgets and their different configuration.
254254
##### Data Options
255255

256256
| Name | Description | Default value | Examples | Not used by |
257-
| - | ------------------------------------------------ | --- | ---------------------------------------- | ----------------- |
257+
|-- | ------------------------------------------------ | --- | ---------------------------------------- | ----------------- |
258258
| start_date | Start date of time period | `7_days_ago` | `2018-01-01`, `2_weeks_ago` | |
259259
| end_date | End date of time period | `today` | `2018-01-31`, `2_weeks_ago` | |
260260
| metrics | Google analytics metrics. Multiple values possible separated with a comma | `sessions,page_views,entrances,unique_page_views` | `bounces,sessions`, `entrances` | |
@@ -318,7 +318,7 @@ Here's the list of every widgets and their different configuration.
318318
##### Data Options
319319

320320
| Name | Description | Default value | Examples | Not used by |
321-
| _ | -- | - | - | ----------------- |
321+
| - | -- | - | - | ----------------- |
322322
| start_date | Start date of time period | `7_days_ago` | `2018-01-01`, `2_weeks_ago` | |
323323
| end_date | End date of time period | `today` | `2018-01-31`, `2_weeks_ago` | |
324324
| metrics | Google Search Console metrics (multiple values possible separated with `,`) | `clicks,impressions,ctr,position` | `query`, `page` | `gsc.table_pages` |
@@ -342,8 +342,8 @@ Here's the list of every widgets and their different configuration.
342342

343343
### Colors
344344

345-
The list of colors you can use with the widgets's options:
346-
345+
The list of colors you can use with the widgets's options.
346+
There displays depend on the colors configured for your terminal.
347347

348348
| Name |
349349
|---------|
@@ -357,13 +357,10 @@ The list of colors you can use with the widgets's options:
357357
| cyan |
358358
| white |
359359

360-
These colors depend on the configuration of your terminal
361-
362360
### Size
363361

364362
Devdash is based on a 12 columns grid.
365-
366-
You can indicate the width of a widget in number of column, or using the equivalent t-shirt size as described below:
363+
You can indicate the width of a widget in number of column (1 to 12), or using the equivalent t-shirt size as described below:
367364

368365
| Name | Number of columns |
369366
| -- | -- |
@@ -379,15 +376,37 @@ You can indicate the width of a widget in number of column, or using the equival
379376

380377
The `start_date` and `end_date` options accept dates following this format: `2016-01-02`.
381378

382-
You can use as well this aliases, relatives to the actual day. This table suppose the actual day is `2019-04-01`
379+
You can use as well aliases relative to the present day.
380+
381+
The same alias can be a different date depending if it's used for the `start_date` or the `end_date` option.
382+
383+
| Name | start_date | end_date |
384+
|--------------|----------------------------------------------------|---------------------------------------------------|
385+
| today | current day | current day |
386+
| yesterday | yesterday | yesterday |
387+
| x_days_ago | `x`th day before the current day | `x`th day before the current day |
388+
|--------------|----------------------------------------------------|---------------------------------------------------|
389+
| this_week | first day of the actual week | last day of the actual week |
390+
| last_week | first day of the last week | last day of the last week |
391+
| x_weeks_ago | first day the `x`th week before the current week | last day the `x`th week before the current week |
392+
|--------------|----------------------------------------------------|---------------------------------------------------|
393+
| this_month | first day of the actual month | last day of the actual month |
394+
| last_month | first day of the last month | last day of the last month |
395+
| x_months_ago | first day the `x`th month before the current month | last day the `x`th month before the current month |
396+
|--------------|----------------------------------------------------|---------------------------------------------------|
397+
| this_year | first day of the actual year | last day of the actual year |
398+
| last_year | first day of the last year | last day of the last year |
399+
| x_years_ago | first day the `x`th year before the current year | last day the `x`th year before the current year |
383400

384-
| Name | start_date | end_date |
385-
| -- | -- | |
386-
| this_week | start of the actual week | end of the actual week |
387-
| last_week | start of the last week | end of the last week |
401+
# Contribute
388402

403+
First of all, thanks a lot if you want to contribute to DevDash!
389404

390-
# Contribute
405+
I think the ["talk, then talk"](https://dave.cheney.net/tag/contributing) practice is pretty good to avoid misunderstandings and hours of work for nothing.
406+
407+
Therefore:
408+
409+
"Every new feature or bug fix should be discussed with the maintainer(s) of the project before work commences. It’s fine to experiment privately, but do not send a change without discussing it first."
391410

392411
# Licence
393412

0 commit comments

Comments
 (0)