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

Add noindex tags to older versions of the docs #187

Merged
merged 1 commit into from
Oct 25, 2023
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Class: ComposeClient"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

[client](../modules/client.md).ComposeClient

The ComposeClient class provides APIs to execute queries on a GraphQL schema generated from a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Class: Context"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

[client](../modules/client.md).Context

GraphQL execution context, exported by the [`client`](../modules/client.md) module.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Class: Composite"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

[devtools](../modules/devtools.md).Composite

The Composite class provides APIs for managing composites (sets of Model streams) through their
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "CLI: composite:* commands"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

The group of [CLI](../modules/cli.md) `composite:*` commands enables the creation and interactions with [Composites](../../guides/concepts-overview.md#composites)

## Command List
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/api/commands/cli.did.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "CLI: did:* commands"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

The group of [CLI](../modules/cli.md) `did:*` commands enables interactions with
DIDs and private keys

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "CLI: document:* commands"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

The group of [CLI](../modules/cli.md) `document:*` commands enables the creation and interactions with [Documents](../../guides/concepts-overview.md#documents)

## Command List
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "CLI: graphql:* commands"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

The group of [CLI](../modules/cli.md) `graphql:*` commands makes it possible to generate GraphQL Schemas from [runtime definitions](./cli.composite.md#composedb-compositecompile) of your [Composites](../../guides/concepts-overview.md#composites) and run a local GraphQL HTTP server

## Command List
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "CLI: model:* commands"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

The group of [CLI](../modules/cli.md) `model:*` commands enables discovery of [Models](../../guides/concepts-overview.md#models), as well as their creation and interactions with them

## Command List
Expand Down
7 changes: 7 additions & 0 deletions website/versioned_docs/version-0.2.x/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ hide_table_of_contents: true
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>



## Modules

- [client](modules/client.md)
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/api/modules/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Module: CLI"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

ComposeDB CLI - the Command Line Interface that enables interactions with a Ceramic Node

You can check the [Getting Started](../../first-composite.mdx) Section for some examples (remember to switch to the 'Using the CLI' tab!)
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/api/modules/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Module: client"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

ComposeDB client.

## Installation
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/api/modules/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Module: devtools"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Development tools library.

## Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Module: devtools-node"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Node.js-specific development tools.

## Installation
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/client-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import TabItem from '@theme/TabItem'

# Client setup

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

## Compiling the composite

In order to interact with a composite at runtime, it is first necessary to create a runtime composite definition file that will be used to configure the client.
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/first-composite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import TabItem from '@theme/TabItem'

# Your first composite

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

ComposeDB provides an abstraction on top of Ceramic streams by leveraging composites, an internal data structure referencing Ceramic model streams and associated metadata. Most of ComposeDB tools and clients interact with various representations of composites.

This page presents how to create your first composite and deploy it to your local Ceramic node, in order to interact with documents on Ceramic.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Concepts overview

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

ComposeDB provides a **graph structure** for interacting with data on the [Ceramic network](https://ceramic.network/).

The **nodes** in the graph can be **accounts** or **documents**, while the **edges** in the graph represent relations between **nodes**.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Supported directives

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Directives provide extra metadata when declaring scalars, lists and shapes.

## Model identification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import TabItem from '@theme/TabItem'

# Creating Composites

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Composites are the abstraction ComposeDB tools and client use to represent and manipulate data models used by applications.

In order to create new composites, especially to create new models that do not already exist on the Ceramic network, a high-level schema can be used as an abstraction for the composite structure.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Supported scalars

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Scalars represent the leaf values in the graph, either as part of key-value properties in shapes, or value of items in lists. You can learn more about scalars in the [GraphQL specification](https://graphql.org/learn/schema/#scalar-types).

## Primitive types
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Schema definition

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Composite schemas are based on [GraphQL's Schema Definition Language](https://graphql.org/learn/schema/), using a subset of functionalities offered by GraphQL to describe models used by ComposeDB.

## Schema Definition Language
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import ThemedImage from '@theme/ThemedImage'

# Data composition

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Data composition is at the heart of ComposeDB, using [composites](./concepts-overview.md#composites) as a proxy for datasets of [documents](./concepts-overview.md#documents) relevant to applications and services.

Composites represent sets of [models](./concepts-overview.md#models) that can be used to query, create and update documents, therefore it is important for developers to identify models to use, whether by [reusing models already adopted by the ecosystem](./using-composites/discovery.mdx) in order to access the set of documents already created using these models, or [creating new models](./creating-composites/overview.mdx) that would better suit specific needs.
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/guides/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,9 @@ import { useCurrentSidebarCategory } from '@docusaurus/theme-common'

# Guides

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

<DocCardList items={useCurrentSidebarCategory().items} />
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Performing mutations

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

## Enabling mutations

In order to perform mutations, the Ceramic instance used by the ComposeDB client needs to be authenticated. This can be done by calling the [`setDID` method](../../api/classes/client.ComposeClient.md#setdid) on the [`ComposeClient`](../../api/classes/client.ComposeClient.md) instance with an authenticated `DID` instance:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Querying the graph

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

The [`ComposeClient`](../../api/classes/client.ComposeClient.md) automatically generates a GraphQL Schema from the runtime composite definition.

It notablly creates a [`CeramicAccount` object](#ceramicaccount-object) that replaces [`DID` scalar](../creating-composites/scalars.md#did) representations, and the root [`Query` object](#query-object) used as an entry-point to acces the graph.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Using Apollo

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

:::tip What is Apollo?

[Apollo](https://www.apollographql.com/docs/react/api/core/ApolloClient) is a popular GraphQL client for React and other platforms.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Using Relay

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

:::tip What is Relay?

[Relay](https://relay.dev/) is a popular GraphQL client for React.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import TabItem from '@theme/TabItem'

# Composites customization

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

## Merging composites

Multiple composites can be merged together into a single composite including all the models from the source composites.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import TabItem from '@theme/TabItem'

# Composites deployment

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

Valid composites can be deployed to any supporting Ceramic node, by ensuring the model streams described in the composite are available on the node, and that the node is configured to index theses models.

## Models deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ import TabItem from '@theme/TabItem'

# Composites discovery

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

ComposeDB does not yet provide a way to discover composites directly, however it is possible to create composites from known models.

## Models discovery
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Using Composites

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

[Composites](../concepts-overview.md#composites) are the primary representation for data models used by ComposeDB. They allow developers to create, share, reuse and combine [models](../concepts-overview.md#models) together in a consistent way.
6 changes: 6 additions & 0 deletions website/versioned_docs/version-0.2.x/installation.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'


# Installation

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

:::caution Developer preview

ComposeDB packages are still under development and only released as a developer preview, they are **not ready for production use**.
Expand Down
5 changes: 5 additions & 0 deletions website/versioned_docs/version-0.2.x/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Welcome to ComposeDB

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

ComposeDB on Ceramic is a decentralized, composable graph database. It provides a set of Typescript libraries and tools that allow developers to quickly build applications on [Ceramic](https://ceramic.network/) — including the ability to discover, create, share and reuse composable data models using [GraphQL](https://graphql.org/).
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Class: ComposeClient"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

[client](../modules/client.md).ComposeClient

The ComposeClient class provides APIs to execute queries on a GraphQL schema generated from a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ title: "Class: Context"
custom_edit_url: null
---

<head>
<meta name="robots" content="noindex" />
<meta name="googlebot" content="noindex" />
</head>

[client](../modules/client.md).Context

GraphQL execution context, exported by the [`client`](../modules/client.md) module.
Expand Down
Loading
Loading