Git Product home page Git Product logo

estuary-docusaurus's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ 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

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.

estuary-docusaurus's People

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

estuary-docusaurus's Issues

Apply for free Algolia again

Because we are an open-source project AND using docusaurus, Algolia should be free. Let's apply for it again, they didn't get back to us last time.

High level Goals

answer the following questions well

  • How do I get access to Estuary?
  • How to put data on Estuary?
  • What are some gotchas? Things you have to work around
  • How do I get data on Estuary?
  • Key issues, explaining the difficulty of things, but showing how much faster we are than existing services
  • Supported Platforms
  • Explain how you can use any language, any library, any interface, etc

proper home page

our docs should have a proper home page instead of just an intro.

Explanation for the client Libraries

Right now the client library documentation is fairly naked. Let's add in:

set up paid algolia

given slowness of getting confirmation on free algolia, let's set up paid to get the ball moving

broken Swagger link (https://docs.estuary.tech/swagger-ui-page)

We can integrate the page at https://docs.estuary.tech/swagger-ui-page into the docusuarus app easily at the same URL /swagger-ui-page

The new docusaurus page uses a slightly different api documentation that includes support for multiple langauges: https://whimsical-marzipan-4409a2.netlify.app/api/introduction/ and uses the postman library to generate code snippets for each API endpoint, so it's a cool light weight way to get code for a specific endpoint that does not integrate the swagger client apis.

Some open questions to me about how to do this:

  1. Do we want to replace the new one for the old and update links / create a redirect?
  2. Do we not like the new one and do we only want to use the old one?
  3. Do we want find a place for both https://docs.estuary.tech/swagger-ui-page and https://whimsical-marzipan-4409a2.netlify.app/api/introduction/ ? - they're both fairly redundant but maybe both have a place

new swagger api documentation introduction

Improve the introduction this page that explains how to use this resource and what it is:

link to the api documentation here: https://whimsical-marzipan-4409a2.netlify.app/api/introduction/

note the nearly blank introduction compared to a page like this: https://whimsical-marzipan-4409a2.netlify.app/api/create-a-new-collection

See this page on the old documentation for inspiration / text to include in the new repo https://docs.estuary.tech/swagger-intro

two click experience for react.js dynamic pages in docs

Following pages are within the "docs" section which generally are .md markup files, but because they require hitting an API they need to be JS react files. There doesn't seem to be a clear way to integrate react/js files into docs, but there must be some way to make it all work:

  • give-feedback
  • get an invite
  • storage provider application
  • chinese version of storage provider application

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.