Giter VIP home page Giter VIP logo

cloudflare-docs-engine's Introduction

cloudflare-docs-engine's People

Contributors

a-robinson avatar adamschwartz avatar adaptive avatar adesege avatar alankemp avatar bradyjoslin avatar bulk88 avatar crwaters16 avatar davidtsong avatar dcpena avatar gganch avatar greg-mckeon avatar ispivey avatar jbampton avatar jrf0110 avatar jspspike avatar kentonv avatar kodster28 avatar kristianfreeman avatar marciocloudflare avatar miltonsim avatar nicolasfont avatar obsidianminor avatar pedrosousa avatar rita3ko avatar rohansingh avatar thmsdnnr avatar travis-r6s avatar tuladhar avatar younggeeks avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cloudflare-docs-engine's Issues

Document DNS requirements for Workers

If a user has a zone already on Cloudflare, it is easy for us to allow them to set up a custom hostname.
It will take some work for us to actually allow people to CNAME to their zoneless Workers, but in the meantime, developers can still deploy to their own custom sites.

To support this without requiring too much user involvement, we would need to:

  • Create a dummy DNS record (if one doesn't already exist for the hostname), i.e. to 1.2.3.4 (to allow external DNS to resolve)
  • Create a wildcard route for the hostname (somewhat related: cloudflare/wrangler-legacy#76 ).

We should document this as the recommended path for custom hostnames (will create separate issue in docs).

Support external links in the sidebar nav

I'm trying to add a link to the REST API in the navbar. With the current design, it'd go in the hamburger - three dot menu as shown in the screenshot below

image

I'm worried these links might be too hidden away for people to see. Could we have these external links in the navbar with some kind of divider to make the distinction? (Could probably include a small h3/4 title too if needed)

Screen Shot 2020-07-30 at 12 24 11 PM

Fix search API/results

The Algolia results currently are coming from the old (current) site:

image

We’ll need to either create a new Algolia account or have it re-crawl once we launch. The crawl probably takes some time / has a delay, so we need to be thoughtful about the coordination of this.

Fix broken links in migrated content

Now that we merged the v0 branch (#62), we need to do a bunch of post-merge cleanup. One such step is fixing all of the broken links (e.g. some links to /about/... need to be changed to /learning/...).

Add V8 Engine version note

The old docs say:

Cloudflare Workers uses the V8 JavaScript engine from Google Chrome. The Workers runtime is updated at least once a week, to at least the version that is currently used by Chrome's stable release. This means you can safely use latest JavaScript features, with no need for "transpilers".

If this is still true, then it should get added to the new docs.

Investigate background blur on images

The placeholder image Gatsby displays is showing through underneath images that have already loaded (if they have transparency in them):

image

https://workers.cloudflaredocs.workers.dev/tutorials/deploy-a-react-app-with-create-react-app

This can’t only be a problem we’ve come across. A little Googling and I found this:

gatsbyjs/gatsby#16516

I may be misunderstanding the issue, but it’s unclear to me why the <span class="gatsby-resp-image-background-image"/> can’t just fade out (read: opacity: 0) after the main image loads.

Create reusable tutorials intro

Every tutorial will essentially need the same boilerplate about how to set up a Cloudflare Workers account, and then install & configure Wrangler.

Let’s see if we can make either one more reusable MDX components which tutorials can import, which would put that setup (or compose portions of it) inside the tutorial, possibly inside an expanding details/summary setup.

Templates section design

We’ve decided to separate what were previously called “Templates” and “Snippets” (in the current Template Gallery 1) into two separate places, “Templates” and “Examples”. The design for the Examples section is now done #3. So what’s left is the new Templates section.

1. image

Add "Quick Start" content

There are lots of links to /quickstart , which doesn't exist here. We should migrate this content.

Make animated GIFs work

Use the gatsby-remark-copy-linked-files plugin (see #22 for an example).


the gatsby-remark-copy-linked-files plugin that was going to be added in @davidtsong's PR #22 seems to fix GIFs working on pages, but appears1 to introduce a new issue, where any directory with an _index.md file begins building the URLs as $PATH/_index:

Screen Shot 2020-06-29 at 1 35 10 PM

this was discovered during #21, but i don't want to scope creep out of the tutorials in that PR so opening this issue for us to continue tracking this.

1: this happened for me locally, and i would love to have someone else test and confirm that this happens for them too!

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.