Skip to content

Commit

Permalink
Move docs (#991)
Browse files Browse the repository at this point in the history
* Move docs

* Fix links, clean up gitignore
  • Loading branch information
Will Scullin authored Jan 17, 2023
1 parent e470265 commit ca9fa7b
Show file tree
Hide file tree
Showing 191 changed files with 65 additions and 42,973 deletions.
9 changes: 1 addition & 8 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# auto-generated docs
docs/_includes/generated/
docs/_site/
docs/documentation/
docs/fiddle/
docs/.jekyll-cache/
docs/js/generated/
docs/aux/generated/
/docs

# Workspace related exclusions
packages/**/build
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To write your own Malloy models, use the VS Code Extension, currently available

![show_run](https://user-images.githubusercontent.com/1093458/182458787-ca228186-c954-4a07-b298-f92dbf91e48d.gif)

To get to know the Malloy language, follow [Malloy by Example](https://malloydata.github.io/malloy/documentation/malloy_by_example.html) and/or continue through the numbered models in the FAA directory.
To get to know the Malloy language, follow [Malloy by Example](https://malloydata.github.io/documentation/malloy_by_example.html) and/or continue through the numbered models in the FAA directory.

Note: The Malloy VSCode Extension tracks a small amount of anonymous usage data. You can opt out in the extension settings.
[Learn more](https://policies.google.com/technologies/cookies).
Expand All @@ -37,9 +37,9 @@ Note: The Malloy VSCode Extension tracks a small amount of anonymous usage data.

Documentation:

- [Malloy Language](https://malloydata.github.io/malloy/documentation/language/basic.html) - A quick introduction to the language
- [eCommerce Example Analysis](https://malloydata.github.io/malloy/documentation/examples/ecommerce.html) - a walkthrough of the basics on an ecommerce dataset (BigQuery public dataset)
- [Modeling Walkthrough](https://malloydata.github.io/malloy/documentation/examples/iowa/iowa.html) - introduction to modeling via the Iowa liquor sales public data set (BigQuery public dataset)
- [Malloy Language](https://malloydata.github.io/documentation/language/basic.html) - A quick introduction to the language
- [eCommerce Example Analysis](https://malloydata.github.io/documentation/examples/ecommerce.html) - a walkthrough of the basics on an ecommerce dataset (BigQuery public dataset)
- [Modeling Walkthrough](https://malloydata.github.io/documentation/examples/iowa/iowa.html) - introduction to modeling via the Iowa liquor sales public data set (BigQuery public dataset)

[YouTube](https://www.youtube.com/channel/UCfN2td1dzf-fKmVtaDjacsg) - Watch demos / walkthroughs of Malloy

Expand Down Expand Up @@ -76,4 +76,4 @@ GROUP BY carrier
ORDER BY flight_count desc -- malloy automatically orders by the first aggregate
```

Learn more about the syntax and language features of Malloy in the [Quickstart](https://malloydata.github.io/malloy/documentation/language/basic.html).
Learn more about the syntax and language features of Malloy in the [Quickstart](https://malloydata.github.io/documentation/language/basic.html).
10 changes: 0 additions & 10 deletions cloudbuild/build-test/build-docs.sh

This file was deleted.

6 changes: 3 additions & 3 deletions demo/malloy-demo-composer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you haven't already done so, you'll need to start by [Building the Malloy rep
1. `npm install` to install dependencies
2. `npm run build` to build all the libraries Malloy needs

Make sure you have a [database connected](https://malloydata.github.io/malloy/documentation/connection_instructions.html), and you'll also likely want to set up the [VS Code Extension](https://github.com/malloydata/malloy#installing-the-extension) to view and edit Malloy files.
Make sure you have a [database connected](https://malloydata.github.io/documentation/connection_instructions.html), and you'll also likely want to set up the [VS Code Extension](https://github.com/malloydata/malloy#installing-the-extension) to view and edit Malloy files.

### Launch the Composer

Expand All @@ -35,14 +35,14 @@ This will start a desktop application. You should see any sources defined in `.m
Troubleshooting notes:

- If you have models in your Malloy models directory and one or all of them are not showing up in the composer menu, you may have an error in your Malloy code. Try opening them up in VS Code with the Malloy Extension installed to find the problem.
- You'll need to define a [source](https://malloydata.github.io/malloy/documentation/language/source.html) for it to be explorable; top-level named queries that are not inside a source are not explorable.
- You'll need to define a [source](https://malloydata.github.io/documentation/language/source.html) for it to be explorable; top-level named queries that are not inside a source are not explorable.

### Set up Query Saving

The composer can write saved queries back to `.a.malloy` files in the Malloy models directory (see below).

1. Create a new file with the suffix `.a.malloy` (e.g. `flights.a.malloy`). You'll need separate ones for each source you want to make explorable.
2. [Import](https://malloydata.github.io/malloy/documentation/language/imports.html) the base file in this `.a.malloy` file, then create a refinement of a source named in the base file. For example, if your base file looks like:
2. [Import](https://malloydata.github.io/documentation/language/imports.html) the base file in this `.a.malloy` file, then create a refinement of a source named in the base file. For example, if your base file looks like:

```malloy
source: flights_base is table('malloy-data.faa.flights'){}
Expand Down
4 changes: 0 additions & 4 deletions docs/404.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/_config.yml

This file was deleted.

15 changes: 0 additions & 15 deletions docs/_includes/banner.html

This file was deleted.

13 changes: 0 additions & 13 deletions docs/_includes/ga.html

This file was deleted.

45 changes: 0 additions & 45 deletions docs/_layouts/documentation.html

This file was deleted.

1 change: 0 additions & 1 deletion docs/_layouts/fiddle.html

This file was deleted.

14 changes: 0 additions & 14 deletions docs/_layouts/redirect.html

This file was deleted.

47 changes: 0 additions & 47 deletions docs/_scripts/build_docs/fiddle.ts

This file was deleted.

70 changes: 0 additions & 70 deletions docs/_scripts/build_docs/highlighter.ts

This file was deleted.

Loading

0 comments on commit ca9fa7b

Please sign in to comment.