Skip to content

Commit

Permalink
move change log images to docs_website (pinterest#1117)
Browse files Browse the repository at this point in the history
* move change log images to docs_website

* mount volume
  • Loading branch information
jczhong84 authored and aidenprice committed Jan 3, 2024
1 parent c79c887 commit afc6769
Show file tree
Hide file tree
Showing 51 changed files with 23 additions and 12 deletions.
3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ RUN yarn install --pure-lockfile
# Copy everything else
COPY . .

# Copy change log images
COPY docs_website/static/changelog/ querybook/static/changelog/

# Webpack if prod
RUN if [ "${PRODUCTION}" = "true" ] ; then ./node_modules/.bin/webpack --mode=production; fi

Expand Down
1 change: 1 addition & 0 deletions containers/docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ services:
volumes:
# This is for code change via watcher
- $PWD:/opt/querybook
- $PWD/docs_website/static/changelog:/opt/querybook/querybook/static/changelog
# See https://stackoverflow.com/questions/29181032/add-a-volume-to-docker-but-exclude-a-sub-folder
- /opt/querybook/node_modules/
# Make sure the build files don't leak back
Expand Down
1 change: 1 addition & 0 deletions containers/docker-compose.prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ services:
volumes:
# This is for code change via watcher
- $PWD:/opt/querybook
- $PWD/docs_website/static/changelog:/opt/querybook/querybook/static/changelog
# See https://stackoverflow.com/questions/29181032/add-a-volume-to-docker-but-exclude-a-sub-folder
- /opt/querybook/node_modules/
# Make sure the build files don't leak back
Expand Down
2 changes: 2 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ x-querybook-depends-on: &querybook-depends-on
x-querybook-volumes: &querybook-volumes
# This is to sync in live code change
- $PWD:/opt/querybook
- $PWD/docs_website/static/changelog:/opt/querybook/querybook/static/changelog
# See https://stackoverflow.com/questions/29181032/add-a-volume-to-docker-but-exclude-a-sub-folder
- /opt/querybook/node_modules/
# Make sure the build files don't leak back
- /opt/querybook/dist/
- /opt/querybook/querybook/static/changelog/
- $PWD/containers/bundled_querybook_config.yaml:/opt/querybook/querybook/config/querybook_config.yaml
# - file:/opt/store/

Expand Down
26 changes: 15 additions & 11 deletions docs_website/docs/changelog/2022-12-20.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Following are the top new features we have added during the year 2022:
- **Customized Tags**: Annotate tags with features like color, tooltip, icon, rank and etc.
- **List V2**: Added nested lists, full page view, and more collectible types.
- **Automatic Query Limit**: A limit clause will be added to a select query without limits.
- **Live Syntax Check**: Validate query syntax and show errors in real time.
- **Query Tanspiler**: Transpile queries between different languages like Presto and SparkSQL.
- **Live Syntax Check**: Validate query syntax and show errors in realtime.
- **Query Transpiler**: Transpile queries between different languages like Presto and SparkSQL.
- **Dag Exporter**: Export a DataDoc as a DAG to systems like Airflow.
- **Customized Schedule Notification**: Scheduled Docs can send notifications to custom Slack alias or email addresses.
- **Event Logging**: Provides the instrumentation support for logging client action events and API events.
- **Event Logging**: Provides instrumentation support for logging client action events and API events.
- **Run All Cells**: Run all query cells in a DataDoc.

## Feature highlights
Expand Down Expand Up @@ -56,7 +56,7 @@ They can also apply this limit for charts, in which case if it is higher than th


### Table Uploader
Users can create and upload a table from a query exeuction result or a file.
Users can create and upload a table from a query execution result or a file.

Upload from query execution
![](/changelog/20221220/tableupload1.png)
Expand Down Expand Up @@ -85,7 +85,7 @@ Added ability to annotate tags with the following features:

![](/changelog/20221220/tag1.png)

You can edit tags by right clicking (only the ones you are allowed to)
You can edit tags by right-clicking (only the ones you are allowed to)
![](/changelog/20221220/tag2.png)
![](/changelog/20221220/tag3.png)

Expand All @@ -108,7 +108,7 @@ If a select query doesn't have a LIMIT clause, Querybook will add a default one
Check the query syntax and show the errors in realtime. The only default support right now is Presto/Trino.
![](/changelog/20221220/syntax.png)

### Query Tanspiler (Experimental)
### Query Transpiler (Experimental)
Users can now transpile queries between Presto and SparkSQL.
![](/changelog/20221220/transpile1.png)
![](/changelog/20221220/transpile2.png)
Expand All @@ -121,13 +121,13 @@ You can add a dag exporter plugin for your dag system to allow users to export a
![](/changelog/20221220/dag3.png)

### Customized Schedule Notification
* User can add a separate notification section for each notify type in the schedule form
* For each notify type, it will have a "Notify To", where users can put either multiple email addresses, or slack channels/ usernames
* Users can add a separate notification section for each notify type in the schedule form
* For each notify type, it will have a "Notify To", where users can put either multiple email addresses or slack channels/ usernames
* The scheduled datadoc will be always run by the datadoc owner
![](/changelog/20221220/notification1.png)

### Event Logging (Experimental)
Add support of event logging with some builtin loggers. Admins can add other loggers through the plugin system.
Added support for event logging with some built-in loggers. Admins can add other loggers through the plugin system.

`DBEventLogger` output example
![](/changelog/20221220/eventlogging.png)
Expand All @@ -145,11 +145,15 @@ Users can now run all query cells of a DataDoc in sequence, like the manual run
- Template variables support for ad-hoc query
- Sync table/column descriptions from metastore
- Added icon for table partition keys
- Show deactivated user with different ui
- Show deactivated user with different UI
- Added syntax highlight/copy to markdown code
- Syntax highlighting for templated queries
- Added schema filtering for table search
- Added task to auto disable unused scheduled docs.
- Added task to auto-disable unused scheduled docs
- Ability to sort templated variables
- Warnings when dropping tables
- Search table with their exact name would auto open the table
- Autosuggest would now add quotes around columns and tables when needed

Querybook Team<br/>
Pinterest<br/>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ def logger_name(self) -> str:
return "null"

def log(
self, uid: int, event_type: EventType, event_data: dict, timestamp: int
self, uid: int, event_type: EventType, event_data: dict, timestamp: int = None
) -> None:
pass
Binary file removed querybook/static/changelog/20200121/board1.gif
Diff not rendered.
Binary file removed querybook/static/changelog/20200121/board2.gif
Diff not rendered.
Binary file removed querybook/static/changelog/20200121/board3.gif
Diff not rendered.
Binary file removed querybook/static/changelog/20200121/board4.gif
Diff not rendered.
Binary file removed querybook/static/changelog/20200121/graph1.gif
Diff not rendered.
Binary file removed querybook/static/changelog/20200121/graph2.gif
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/copy1.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/graph1.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/graph2.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/schedule1.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/schedule2.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/search1.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/search2.png
Diff not rendered.
Binary file removed querybook/static/changelog/20200527/template1.png
Diff not rendered.
Binary file removed querybook/static/changelog/20221220/querysearch.png
Diff not rendered.

0 comments on commit afc6769

Please sign in to comment.