Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce new docs site #862

Merged
merged 8 commits into from
Jul 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- uses: actions/checkout@v2
- uses: volta-cli/action@v1
with:
node-version: 10.x
node-version: 14.x
- run: yarn install --frozen-lockfile
- run: yarn lint
- run: yarn compile
Expand All @@ -30,6 +30,6 @@ jobs:
- uses: actions/checkout@v2
- uses: volta-cli/action@v1
with:
node-version: 10.x
node-version: 14.x
- run: yarn install --frozen-lockfile
- run: yarn test
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ node_modules
*.log
tmp
dist
docs
tests-build
tests-static
.cache
Expand Down
9 changes: 3 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,16 @@
"build": "lerna run build",
"compile": "lerna run build && lerna run compile",
"test": "lerna run build && lerna run --concurrency 1 test",
"lint": "lerna run lint",
"typedoc": "typedoc"
"lint": "lerna run lint"
},
"devDependencies": {
"@orbit/prettier-config": "^1.0.0",
"lerna": "^3.22.1",
"prettier": "^2.2.1",
"typedoc": "^0.20.25",
"typedoc-plugin-lerna-packages": "^0.3.1"
"prettier": "^2.2.1"
},
"prettier": "@orbit/prettier-config",
"volta": {
"node": "10.23.0",
"node": "14.17.3",
"yarn": "1.22.10"
},
"workspaces": [
Expand Down
27 changes: 5 additions & 22 deletions packages/@orbit/records/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,19 @@
# @orbit/record-source
# @orbit/records

Applies the primitives from @orbit/core to data sources. Includes the following
elements:

- A schema for defining models, including attributes and relationships.

- Operations used to manipulate records (e.g. `addRecord`, `removeRecord`,
`addToHasMany`, etc.).

- Transforms, which are composed of any number of operations, and must be
performed transactionally.

- A query language that allows query expressions to be composed in a flexible
AST form.

- A base `Source` class that can be used to abstract any source of data.
Sources can be decorated as `pullable`, `pushable`, `queryable`, `syncable`,
and/or `updatable` - each decorator provides a unique interface that allows
for transforms and queries to be applied as appropriate.
Extends the primitives from `@orbit/data` to be record-specific.

### Installation

Install with yarn:

```
yarn add @orbit/data
yarn add @orbit/records
```

Or with npm:

```
npm install @orbit/data
npm install @orbit/records
```

## Contributing
Expand Down Expand Up @@ -72,4 +55,4 @@ yarn start

## License

Copyright 2014-2020 Cerebris Corporation. MIT License (see LICENSE for details).
Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).
11 changes: 0 additions & 11 deletions typedoc.json

This file was deleted.

20 changes: 20 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
33 changes: 33 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
11 changes: 11 additions & 0 deletions website/blog/2021-07-12-welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
slug: welcome
title: Welcome to the new Orbitjs.com
author: Dan Gebhardt
author_title: Orbit.js Creator
author_url: https://github.com/dgeb
author_image_url: https://avatars.githubusercontent.com/u/29122?v=4
tags: [documentation, docusaurus]
---

I'm excited to announce a new site for Orbit! 🎉
2 changes: 2 additions & 0 deletions website/docs/api/coordinator/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: "@orbit/coordinator"
position: 1
2 changes: 2 additions & 0 deletions website/docs/api/coordinator/classes/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: "Classes"
position: 3
Loading