Skip to content
Snippets Groups Projects
Unverified Commit b337f510 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - frontmatter (#23272)

parent 5253f8cb
No related merge requests found
Showing
with 103 additions and 16 deletions
---
title: "Task"
summary: "/api/task endpoints."
---
# Task
/api/task endpoints.
......
---
title: "Tiles"
summary: "`/api/tiles` endpoints."
---
# Tiles
`/api/tiles` endpoints.
......
---
title: "Timeline event"
summary: "/api/timeline-event endpoints."
---
# Timeline event
/api/timeline-event endpoints.
......
---
title: "Timeline"
summary: "/api/timeline endpoints."
---
# Timeline
/api/timeline endpoints.
......
---
title: "Transform"
summary: "API endpoints for Transform."
---
# Transform
API endpoints for Transform.
- [GET /api/transform/:db-id/:schema/:transform-name](#get-apitransformdb-idschematransform-name)
## `GET /api/transform/:db-id/:schema/:transform-name`
......
---
title: "User"
summary: "/api/user endpoints."
---
# User
/api/user endpoints.
......
---
title: "Util"
summary: "Random utilty endpoints for things that don't belong anywhere else in particular, e.g. endpoints for certain admin
page tasks."
---
# Util
Random utilty endpoints for things that don't belong anywhere else in particular, e.g. endpoints for certain admin
......
**The overall goal of a code review is to serve as a safety net for other people on our team and help them write better code, not to judge them or their code. When in doubt, assume that they have good intentions and BE NICE.**
---
title: Code reviews
---
# Code reviews
The overall goal of a code review is to serve as a safety net for other people on our team and help them write better code, not to judge them or their code. When in doubt, assume that they have good intentions and BE NICE.
## Goals:
......
---
title: Thank you
---
## Thank you
First off, thanks for your interest in Metabase and for wanting to contribute!
......@@ -87,4 +91,4 @@ Generally speaking, any issue in [Help Wanted](https://github.com/metabase/metab
### #YOLO JUST SUBMIT A PR
If you come up with something really cool, and want to share it with us, just submit a PR. If it hasn't gone through the above process, we probably won't merge it as is, but if it's compelling, we're more than willing to help you via code review, design review and generally OCD nitpicking so that it fits into the rest of our codebase.
If you come up with something really cool, and want to share it with us, just submit a PR. If it hasn't gone through the above process, we probably won't merge it as is, but if it's compelling, we're more than willing to help you via code review, design review and generally OCD nitpicking so that it fits into the rest of our codebase.
\ No newline at end of file
---
title: Partner and community drivers
---
# Partner and community drivers
In addition to our [Officially supported drivers](./administration-guide/01-managing-databases.md#officially-supported-databases), many people build and maintain drivers for database integrations.
......@@ -75,4 +79,4 @@ If you are having problems installing or using a community driver, your best bet
## Write your own driver
Check out [Guide to writing a Metabase driver](./developers-guide/drivers/start.md).
Check out [Guide to writing a Metabase driver](./developers-guide/drivers/start.md).
\ No newline at end of file
---
title: "Deprecated Developer's guide"
---
<!-- Do not remove this file since the published HTML in the public doc
(https://www.metabase.com/docs/latest/developers-guide.html)
is often referred to in various issues, discussions, etc -->
Please refer to the detailed [Developer's Guide](developers-guide/start.md).
\ No newline at end of file
Please refer to the detailed [Developer's Guide](developers-guide/start.md).
---
title: Building Metabase
---
# Building Metabase
This doc will show you how you can build and run Metabase on your own computer so you can play around with it or test features in development. You can also run development branches of Metabase [using a pre-built Docker image](dev-branch-docker.md).
......@@ -157,5 +161,4 @@ The entire Metabase application is compiled and assembled into a single .jar fil
./bin/build
After running the build script simply look in `target/uberjar` for the output .jar file and you are ready to go.
After running the build script simply look in `target/uberjar` for the output .jar file and you are ready to go.
\ No newline at end of file
---
title: Working with Clojure
---
# Working with Clojure
Check out [Clojure for the Brave and True](https://www.braveclojure.com/clojure-for-the-brave-and-true/). It's free online.
If you don't feel like reading a whole book, [Mark Volkmann's Clojure tutorial](https://objectcomputing.com/resources/publications/sett/march-2009-clojure-functional-programming-for-the-jvm) is another good starting point.
If you don't feel like reading a whole book, [Mark Volkmann's Clojure tutorial](https://objectcomputing.com/resources/publications/sett/march-2009-clojure-functional-programming-for-the-jvm) is another good starting point.
\ No newline at end of file
---
title: Contributing
---
# Contributing
In general, we like to have an open issue for every pull request as a place to discuss the nature of any bug or proposed improvement. Each pull request should address a single issue, and contain both the fix as well as a description of the pull request and tests that validate that the PR fixes the issue in question.
......
---
title: How to run a development branch of Metabase using Docker
---
# How to run a development branch of Metabase using Docker
If you want to run a branch of Metabase that's currently in development, the easiest way to get started is to use a pre-built Docker image. You can also [compile Metabase yourself](build.md).
......@@ -49,4 +53,4 @@ Then:
docker run --platform linux/amd64 -d -p 3000:3000 --name metabase metabase/metabase-enterprise-head:latest
```
The “latest” tag is not automatically upgraded on your local machine, so the above commands ensure that you’re pulling the latest changes.
The “latest” tag is not automatically upgraded on your local machine, so the above commands ensure that you’re pulling the latest changes.
\ No newline at end of file
---
title: Development environment
---
# Development environment
The Metabase application has two basic components:
......@@ -230,4 +234,4 @@ It is also possible to execute front-end and back-end checks separately
```sh
$ yarn ci-frontend
$ yarn ci-backend
```
```
\ No newline at end of file
---
title: Driver Interface Changelog
---
# Driver Interface Changelog
## Metabase 0.43.0
......@@ -130,4 +134,4 @@ table below:
| 0.38.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.38.0-for-Metabase-driver-authors) |
| 0.37.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.37.0-for-Metabase-driver-authors) |
| 0.36.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.36.0-for-Metabase-driver-authors) |
| 0.35.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.35.0-for-Metabase-driver-authors) |
| 0.35.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.35.0-for-Metabase-driver-authors) |
\ No newline at end of file
---
title: Database driver basics
---
# Database driver basics
A Metabase driver:
......@@ -65,4 +69,4 @@ This is the core file for your driver. We'll talk more about it in [Implementing
We'll learn more about [plugin manifests](plugins.md).
[env-var]: ../../operations-guide/environment-variables.html
[env-var]: ../../operations-guide/environment-variables.html
\ No newline at end of file
---
title: Submitting a PR for a new driver
---
# Submitting a PR for a new driver
If you want to submit a PR to add a driver plugin to the [Metabase repo](https://github.com/metabase/metabase) (as opposed to keeping it in a separate repo), you'll need to:
......@@ -239,5 +243,4 @@ and the steps:
MB_POSTGRES_SSL_TEST_SSL_ROOT_CERT_PATH=/home/circleci/metabase/metabase/test-resources/certificates/us-east-2-bundle.pem
```
For more on what it is you're doing here and how all this works, see [CircleCI 2.0 Workflows](https://circleci.com/docs/2.0/workflows/).
For more on what it is you're doing here and how all this works, see [CircleCI 2.0 Workflows](https://circleci.com/docs/2.0/workflows/).
\ No newline at end of file
---
title: Implementing multimethods for your driver
---
# Implementing multimethods for your driver
Implementing multimethods lets you take advantage of Metabase's existing driver code by extending those methods to work for your particular database.
......@@ -135,4 +139,4 @@ To start a REPL.
clojure -A:dev:drivers:drivers-dev
```
You'll need to rebuild the driver and install it in your `./plugins` directory, and restart Metabase when you make changes.
You'll need to rebuild the driver and install it in your `./plugins` directory, and restart Metabase when you make changes.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment