getredash / website Goto Github PK

View Code? Open in Web Editor NEW

77.0 23.0 457.0 102.57 MB

Redash homepage and Knowledge Base

Home Page: https://redash.io

License: BSD 2-Clause "Simplified" License

JavaScript 72.42% Dockerfile 0.04% SCSS 27.55%

website's Introduction

Redash Website and Knowledge Base

We use Gatsby as our static site generator. The website is built and hosted with Netlify.

Updating contributors data file

yarn fetch-contributors > website/_data/contributors.json

Website development

Gatsby Installed Locally

This seems to depend on Node v10. Until the dependencies updated to support newer versions of Node, you can use the Docker setup.

To start Gatsby in development mode and serve the the website on http://localhost:8000 use:

yarn run develop

If you prefer Gatsby listen on an interface or IP address other than localhost, use:

yarn run develop -H ip_address

For example:

yarn run develop -H 10.11.12.13

Using a DNS name in place of an IP address will also work, assuming the DNS entry resolves to an IP address on the local machine. This can be achieved through editing your /etc/hosts.

Docker Setup

First install dependencies:

docker-compose run --rm gatsby install

On first run, it will build the Docker image we're using. Once the Node modules were installed, you can run the following to start the dev server:

docker-compose up -d

This will run gatsby develop in the Docker container in the background, listening on http://localhost:8000. The first time you run this command it might take a few moments for Gatsby to compile the website. You can check progress by tailing the logs:

docker-compose logs -f

You can edit the project locally and the changes will be reflected inside the Docker container.

website's People

Contributors

Stargazers

Watchers

Forkers

digideskio openjck jpotts18 vishesh92 tkasang pombredanne xty88645 antoineaugusti kakakakakku amarjayr ironistm bambina-zz kocsmy cloudron-io shigemk2 www3838438 giansegato kaznishi tonyjiangh yogesum vitaminl saracampogil jeffzakrzewski scintylla dh573 lordgrenville kyoshidajp rawatravi ved12 guzhenping denisov-vlad vivekrathi8993 bigff sharevong jyothigandi hbceylan irwanhub2016 taminif luotuoxiangzai liupt yuta-ishizaka fengshow12345 youyuxiansen todd-agfc boudewijn26 tezou3 mrcirca stochaschic ferhatelmas cjpit cleverventi newlifehejian esragumustop scs891 alexanderlz diveshtolani alliesarvey tranhuongk aaronte wxh1000 k-tomoyasu tjengel qokoro gabopp rasmi hthp1010 fuzzfree nikhilranka jeffersfp adamor phawley lotusfairy isakotsubo ranbena sandesh2323 yuxuanjanet eyarz mguerin1408 ricardo-cloudster jasonthomas windancer79 shosti mllearnng carlosmba136 gugu yuyu816 delissgt abhinavbihade dirkbosman karenwang7 zohaibhashmi khushbu-maurya raghav111jain dhruv9499 watertraveller abhikc deepanshu-kandpal mahuanfy andrewkononuchenko anfell

website's Issues

Top menu "Help" dropdown click target

The Help menu on the navbar is a dropdown. At the moment I need to click on the font glyphs to invoke the menu; but this isn't obvious. When I hover over the <div> the entire thing changes its background color which makes me think that I can click anywhere on the element to invoke the menu. Alternatively, it looks like I need to click the down arrow to invoke the menu -- but this is hard to get exactly right with a mouse because the arrow is so small.

In this ten second GIF I demonstrate the three behaviors:

Clicking on the word "Help" invokes the menu
Clicking in blankspace on the <div> does nothing
Clicking on the tiny down arrow invokes the menu

Can we change this to either make the down arrow bigger or even better: invoke the dropdown menu whenever the user clicks the entire <div>?

How to make a dropdown list of dates

Not sure if this belongs in the documentation or separately as a blog post. But we should include a recipe for how to make a drop-down list of dates.

Add MemSQL to list of datasources

Resize website images

Make sure the website lists all available data source types

Check website
Check docs
Create a new file for each of the new ones for the marketing website here:
https://github.com/getredash/website/tree/master/website/_data_sources

BigQuery setup documentation mentions non-existent permission

In https://redash.io/help/data-sources/setup/bigquery#BigQuery-Permissions-and-Roles, it lists bigquery.datasets.list as a required permission, but that permission doesn't exist in GCP (see https://cloud.google.com/bigquery/docs/access-control).

Missing example in "Date Range Parameters"

Just noticed our "Data Range Parameters" doc is missing the example piece:

You will typically need to separate them in your query (into different
`WHERE` clauses, e.g.).

Gatsby: knowledge base homepage has spacing issues

Fix dead links in the user guide

Document Choropleth options

in MAP(choropleth), is there any work around to show text in the ValueColumn field? I managed to get a text from my query but couldn't show the text when user hover over the countries.

As for the map: the value column has to be a number, as this defines the intensity of the region color. If you don't mind about the color, you can return a static value (like just 1) and use it as a value.

To customize the tooltip that shows on hover or the full message that shown on click, you can use the following options:

This allows you to reference any column from the query (click on the ? button next to "Format specs" for reference).

Improve Knowledge Base articles "footer"

The "Edit on GitHub" link is often missed, we need to make it more visible.
Better case study section on Customers page
Add "Was this helpful? 👍👎" section
Maybe need to position the was it helpful part on the left and edit link on the right.
Add thank you animation @kocsmy
Implement logic for "Did you find this useful" @arikfr
kb-category.html also needs "Edit on GitHub" button (it's only on kb-article.html currently)

Gatsby: homepage has wrong spacing

Admin Guide: env vars being incorrect displayed

At https://redash.io/help/open-source/admin-guide/env-vars-settings, env vars are being incorrectly displayed due to Markdown rendering, using the underscores from the vars names to make them italic:

Mention user name format for Azure SQL database

The user should be in the format of user@server-name. server-name will be abcdef in the case of server address like abcdef.database.windows.net.

Website does not load sometimes

I bumped into this twice so far (and I'm not visiting it too often), that the marketing site won't load:

Refresh resolved the issue though. I'd add a critical flag to this.

Troubleshooting connection issues page

Preview

Connection problems will generally fall into three categories:

The target database is improperly configured
The IP connection is interupted
Redash is improperly configured

If you’re using the Hosted Redash service and your data source is behind a firewall, you need to allow access from the IP address 52.71.84.157 in your database firewall/Security Groups.

Apart from this portion in the Getting Started guide, what are other common connection problems? Are there particular databases that error-out more than others?

Initial Steps

Confirm database is accessible apart from Redash: Most databases provide a command line application (CLI). Confirm with this CLI that the database is operational.

Confirm your firewall will accept connections from 52.71.84.157: Should we provide examples in common firewalls like PFsense, IIS, UFW etc?

Request for feedback

Before I put this together I'd like to know what questions we commonly see.

Add documentation for ISO 8601 Dates with MongoDB Queries

If you try to pass a datetime parameter to MongoDB it will never match properly because there is currently a mismatch between the format we provide and what MongoDB expects. You can remedy this by wrapping the parameter value with the $humanTime extension, i.e.: {"$humanTime": "{{ param }}"} where you would use just "{{param}}".

Opening slide for video guides

We're about to produce a few video guide and need an opening slide for them, to use when giving an intro to the video and as a preview screenshot in Youtube.

The slide should contain:

Redash logo
Video title
(optional) Preview image

Bug: Knowledge Base searchbar partially clickable

In the mobile version, only the top part is clickable.

Happens in help drawer, Chrome, Linux.

Missing image in User Guide -> Permissions & Groups page

Reading through the Permissions & Groups page in our User Guide, a text fragment says:

The screenshot shown below shows a Dashboard Widget with a visualization the
user doesn’t have access to.

Unfortunately, there's no screenshot on the page. 😉

We should either nuke that line of text, or (better) add an appropriate screenshot. 😄

Add a LICENSE

I am unable to contribute to repositories without a license, can you add one? I'm hoping to add new features and would like to add documentation when I do so.

error UNHANDLED REJECTION , TypeError: Cannot read property 'children' of undefined

when I gatsby develop the project, it happend:

$ gatsby develop
success open and validate gatsby-configs — 0.026 s
success load plugins — 0.597 s
success onPreInit — 4.343 s
success delete html and css files from previous builds — 0.139 s
success initialize cache — 0.009 s
success copy gatsby files — 0.250 s
success onPreBootstrap — 0.008 s
error UNHANDLED REJECTION


  TypeError: Cannot read property 'children' of undefined

  - actions.js:50 children.concat.children.map.child
    [website]/[gatsby]/dist/redux/actions.js:50:39

  - Array.map

  - actions.js:49 findChildrenRecursively
    [website]/[gatsby]/dist/redux/actions.js:49:42

  - actions.js:301 actions.deleteNode.args
    [website]/[gatsby]/dist/redux/actions.js:301:29

  - redux.js:468
    [website]/[redux]/lib/redux.js:468:35

  - source-nodes.js:77 staleNodes.forEach.node
    [website]/[gatsby]/dist/utils/source-nodes.js:77:34

  - Array.forEach

  - source-nodes.js:77
    [website]/[gatsby]/dist/utils/source-nodes.js:77:18

  - Generator.next


error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Broken link to query syntax documentation

While looking around for info on how to transform textual date strings into a date/time format Redash can use, this 404 link in the current docs became apparent:

The page with the broken link:

https://redash.io/help/user-guide/querying/writing-queries#Query-Syntax

The 404 link page:

https://redash.io/help/data-sources/querying/querying_category

Add Snowflake to list of supported data sources

(after the release of v1)

Add Cloudron as installation option

Hi Redash team,
We have been maintaining a redash package for Cloudron for a while now at https://git.cloudron.io/cloudron/redash-app. This app was initially contributed to us by Domenic. We have automated browser tests for testing installs and updates as well in the tests/ directory. There's a demo at https://my.demo.cloudron.io (username: cloudron password: cloudron) if you want to see how redash works on Cloudron.

Would be great if you could add Cloudron as an installation method in your docs. Thanks!

In page documentation links open have an offset

When using an anchor link on a documentation page, it opens the page with some offset:

https://cl.ly/28de24f8a420

Instead of:

https://cl.ly/0ef15128a708

When using this link: https://redash.io/help/user-guide/querying/query-parameters#parameter-settings

Gatsby: privacy policy page lead paragraph has wrong font size

Add documentation of "safe" parameter types

Consistent with this PR on the main repo, we should have a note to say which parameter types can be embedded safely. This is a self-correcting problem because they'll eventually all be safe.

Add new logos to the customers page

Atlassian (logo can be found at: https://atlassian.design)
Datree (datree.io)

Don't run Algolia indexing on non master builds

Document issue with angular brackets (< >)

(and the replace workaround)

Google dev account setup docs misnumbering

In https://github.com/getredash/website/blob/master/website/_kb/open-source/admin-guide/google-developer-account-setup.md (the source for https://redash.io/help/open-source/admin-guide/google-developer-account-setup) the indented numbered list renders at the same level as the surrounding items, rather than appearing as sub-items under item 1 of the main list.

Non-existent JSON loading feature is documented for URL datasource

The URL datasource documentation documents a JSON datasource option that can process an arbitrary JSON (which would be awesome). We just spent 20 minutes trying to figure out how to use it and in fact didn't find any traces of such support in the redash codebase at all.

Overkill 80px h3 padding top should be fixed

I believe that 80px padding is just accidental and you didn't mean to implement for this element.

Explain how to get the spreadsheet ID

So for example, if the spreadsheet URL is:
https://docs.google.com/spreadsheets/d/1DFuuOMFzNoFQ5EJ2JE2zB79-0uR5zVKvc0EikmvnDgk/edit#gid=0

Then the id will be 1DFuuOMFzNoFQ5EJ2JE2zB79-0uR5zVKvc0EikmvnDgk.

Testimonials on pricing page?

Like this:

It's best to see the real thing to understand the interaction. It's from Netlify's pricing page.

@kocsmy what do you think?

New Help page: Basic Markdown guide

Meant to be linked to from Textbox editor.
Copy content from https://www.markdownguide.org/cheat-sheet/#basic-syntax

Gatsby: KB category pages don't respect "order" property

The articles on a category page should be sorted using order (if available) and all the articles without order should be pushed to the bottom.

website images redirect to http://help.redash.io/

I can't find any images in redash website.
http://help.redash.io/article/61-creating-a-dashboard

These images are redirect to http://help.redash.io/

➜  ~ curl https://redash.io/help/assets/gifs/dashboards/Dashboards.gif
Redirecting to http://help.redash.io/

Add HTML Proofer to the build step of the website/docs

https://github.com/gjtorikian/html-proofer

Add note about "Insufficient permissions to execute the query." message when querying Athena

Error running query: Insufficient permissions to execute the query.

Usually means that you need to give access to the S3 bucket to your IAM user.

Is it possible to make query parameters optional?

Currently, if the user doesnt enter a value, it gives error.

Document how to render content with brackets

getredash/redash#755 (comment)

Footer for the forum like Ghost have

The export query results section should mention query api key

The export query results section should recommend using query's API Key (and explain how to obtain it) vs. the user's API key. The user's API key should be mentioned as an option at the end, but the recommended one is the query API key.

Links defined with '{% link ... %} are 404 in production redash.io

While reading through the docs for Query Filters and Query parameters, some of the links turned out to be 404. Looking that their source in the repo, it might be something gone wrong with '{% link ... %}' replacement.

Examples

Query parameters page

https://redash.io/help/user-guide/querying/query-parameters (source)

This has a small paragraph:

Also, a Redash user must have Full Access permission to the data source
to use Query Parameters.

There is a link on the "Full Access" text, to: "https://redash.io/help/user-guide/querying/%7B%25%20link%20_kb/user-guide/users/permissions-groups.md%20%20%25%7D"

It looks like the link wasn't replaced with the correct internal destination page when the website was generated.

Query filters page

https://redash.io/help/user-guide/querying/query-filters (source)

It has this text:

If you'd like to link together the filter widgets into a dashboard-level Query Filter see these instructions.

There is a (broken) link on "these instructions", to "https://redash.io/help/user-guide/querying/%7B%25%20link%20_kb/user-guide/dashboards/dashboard-editing.md%20%20%25%7D"

Haven't checked any further links, but seems more like a website generation problem rather than one or two broken ones.