Skip to content
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
1 change: 0 additions & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,6 @@

# Docs team areas

/src/content/docs/docs-guide/ @dcpena @cloudflare/pcx-technical-writing
/src/content/docs/style-guide/ @dcpena @cloudflare/pcx-technical-writing

# Google tag gateway
Expand Down
6 changes: 5 additions & 1 deletion public/__redirects
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@
/cloudflare-one/email-security/setup/post-delivery-deployment/api/office365-api/ /cloudflare-one/email-security/setup/post-delivery-deployment/api/m365-api/ 301
/cloudflare-one/email-security/setup/post-delivery-deployment/bcc-journaling/journaling-setup/office365-journaling/ /cloudflare-one/email-security/setup/post-delivery-deployment/bcc-journaling/journaling-setup/m365-journaling/ 301
/cloudflare-one/email-security/setup/pre-delivery-deployment/prerequisites/microsoft365-email-security-mx/ /cloudflare-one/email-security/setup/pre-delivery-deployment/prerequisites/m365-email-security-mx/ 301
/cloudflare-one/email-security/setup/post-delivery-deployment/bcc-journaling/journaling-setup/manage-domains/ /cloudflare-one/email-security/setup/manage-domains/ 301
/cloudflare-one/email-security/setup/post-delivery-deployment/bcc-journaling/journaling-setup/manage-domains/ /cloudflare-one/email-security/setup/manage-domains/ 301

# firewall
/firewall/api/cf-lists/ /waf/tools/lists/lists-api/ 301
Expand Down Expand Up @@ -1315,6 +1315,10 @@

# style guide

/docs-guide/ /style-guide/how-we-docs/ 301
/docs-guide/manage-content/ /style-guide/how-we-docs/ 301
/docs-guide/manage-content/automation/ /style-guide/how-we-docs/ 301
/docs-guide/manage-content/automation/process/ /style-guide/how-we-docs/ 301
/docs-guide/manage-content/redirects/ /style-guide/how-we-docs/redirects/ 301
/docs-guide/manage-content/redirects/best-practices/ /style-guide/how-we-docs/redirects/ 301
/docs-guide/manage-content/redirects/process/ /style-guide/how-we-docs/redirects/ 301
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 0 additions & 10 deletions src/content/docs/docs-guide/index.mdx

This file was deleted.

29 changes: 0 additions & 29 deletions src/content/docs/docs-guide/manage-content/automation/index.mdx

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions src/content/docs/docs-guide/manage-content/index.mdx

This file was deleted.

52 changes: 52 additions & 0 deletions src/content/docs/style-guide/how-we-docs/our-site.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
pcx_content_type: how-to
title: Our site
meta:
title: Our site | How we docs
---

We use a variety of tools to make our docs site work. You could use these tools to build up your own docs site and - in most cases - do so for free or starting on a free tier.

## Content management system

Our content lives in a public GitHub repository, [`cloudflare-docs`](https://github.com/cloudflare/cloudflare-docs).

GitHub offers a generous [free tier](https://github.com/pricing).

## Search

We use [Algolia](https://www.algolia.com/) as our search provider.

If you have open-source docs, you can be part of the free [DocSearch program](https://docsearch.algolia.com/).

## Site framework

We use [Starlight](https://starlight.astro.build/) for our docs, which is a free, custom documentation theme supported by [Astro](https://astro.build/).

Astro's [component overrides](https://starlight.astro.build/guides/overriding-components/) and [plugins](https://starlight.astro.build/resources/plugins/) system were a big part of us [choosing this framework](https://blog.cloudflare.com/open-source-all-the-way-down-upgrading-our-developer-documentation/) and have exponentially increased our site's capabilities (without much extra work).

## Builds

We use [GitHub Actions](https://github.com/features/actions) to build our site, which is then [hosted](#hosting) on Cloudflare.

We are moving to [Workers CI/CD](/workers/ci-cd/), which currently runs in the background.

Both of these options include a free tier.

## Hosting

We host our content using [Cloudflare Workers](/workers/static-assets/), specifically using their built in values for [Astro sites](/workers/framework-guides/web-apps/astro/)

Workers offers a generous [free tier](/workers/platform/pricing/).

## Analytics

We send analytics to multiple destinations using [Cloudflare Zaraz](/zaraz/), which has a generous [free tier](/zaraz/pricing-info/).

:::note

If you want to opt out of analytics tracking, use the icon at the bottom of your screen.

![Opt out of analytics with the icon at the bottom of your screen](~/assets/images/style-guide/how-we-docs/privacy-opt-out.png)

:::
12 changes: 0 additions & 12 deletions src/content/products/docs-guide.yml

This file was deleted.

Loading