Skip to content
This repository was archived by the owner on Jan 3, 2023. It is now read-only.
Open
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
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,7 @@ node_modules/
.idea
.DS_Store

.hugo_build.lock

# Local Netlify folder
.netlify
54 changes: 2 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We welcome contributions to improve the documentation. Simply open a pull reques
- Install from source (with SCSS support) with:

```
git checkout github.com/gohugoio/hugo
git clone https://github.com/gohugoio/hugo.git
cd hugo
go install -v --tags extended
```
Expand All @@ -18,38 +18,9 @@ go install -v --tags extended
To start the hugo server, run this command:

```sh
hugo server
hugo serve
```

### GraphQL API Reference

The GraphQL API Reference content is generated straight from the GraphQL schema of the different products
we support.

To update them, a pre-defined project layout on disk is expected by the script. You must have the three
following project colocated as siblings alongside the `docs` project:

- `docs`
- `dfuse-eosio`
- `dfuse-ethereum`

The later two must be named verbatim, the first one `docs` could be named whatever you like. Once the
following layout exist on your local workstation, to update the GraphQL generate API reference data,
first install the script dependencies:

```
npm install
```

Then run the following command:

```
node graphql.js
```

This should update the file `data/eos/graphql.json` and `data/eth/graphql.json` (and any other
chains we now support) if the GraphQL schema has been updated.

## Content Structure

All content can be found in the `/content` directory. The structure of the website is generated automatically based on the structure of that directory.
Expand Down Expand Up @@ -105,24 +76,3 @@ Example code can then be referenced with the following shortcode:
- real-time
- GraphQL
- API

## Deployment

Any commit to master automatically triggers a deployment. For this reason, the master branch is locked, requiring all changes to go through an approved pull request.

Reference
ETH -=> Endpoint ALPHA

<new> side menu

alpha (red)
beta (yeallo-orangy)
stage (light gray)
add sub-title to graphql shortcode
fix

refactor pages

```

```
23 changes: 10 additions & 13 deletions config.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
{
"baseURL": "/",
"languageCode": "en-us",
"title": "dfuse docs",
"title": "Firehose Documentation",
"theme": "book",
"enableGitInfo": true,
"params": {
"DfuseLogo": "dfuse-logo.svg",
"DfuseLogo": "firehose-logo-white.png",
"BookToC": 5,
"BookSections": {
"admin-guide": "show",
"public-apis": "show",
"dev-guide": "show",
"eosio": "show",
"ethereum": "show",
"platform": "show"
"operators": "show",
"integrators": "show",
"developers": "show"
},
"PerSectionTagline": {
"eosio": "EOSIO Documentation",
"ethereum": "Ethereum Documentation",
"platform": "Platform",
"operators": "Operators Documentation",
"integrators": "Integrators Documentation",
"developers": "Developers Documentation",
"topLevel": "Documentation"
},
"CustomCss": ["css/override.css"],
"BookRepo": "https://github.com/dfuse-io/docs",
"CustomCss": ["css/fontawesome.all.css", "css/override.css"],
"BookRepo": "https://github.com/streamingfast/docs",
"BookEditPath": "edit/master/content",
"SectionPagesMenu": "main"
},
Expand Down
8 changes: 1 addition & 7 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
weight: 1
title: dfuse open-source platform for blockchain data
title: StreamingFast - Firehose streaming blockchain's data
layout: full-width
aliases:
- /guides/
- /reference/
- /samples/
- /libraries/
- /release-notes/
---

{{< partial "home-overview" >}}
16 changes: 0 additions & 16 deletions content/eosio/admin-guide/_index.md

This file was deleted.

44 changes: 0 additions & 44 deletions content/eosio/admin-guide/backup-recovery.md

This file was deleted.

9 changes: 0 additions & 9 deletions content/eosio/admin-guide/cloud-specific-guide.md

This file was deleted.

Loading