Skip to content

Commit 1c133fc

Browse files
kodster28caley-b
authored andcommitted
[Style guide] Build setup (#23730)
* [Style guide] Build setup * clarification * Builds * Update * rephrase * privacy opt out * remove docs guide entirely * codeowners * Update src/content/docs/style-guide/how-we-docs/our-site.mdx Co-authored-by: Caley Burton <[email protected]> * show some astro love --------- Co-authored-by: Caley Burton <[email protected]>
1 parent c39cec0 commit 1c133fc

File tree

9 files changed

+57
-105
lines changed

9 files changed

+57
-105
lines changed

.github/CODEOWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,6 @@
150150

151151
# Docs team areas
152152

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

156155
# Google tag gateway

public/__redirects

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@
516516
/cloudflare-one/email-security/setup/post-delivery-deployment/api/office365-api/ /cloudflare-one/email-security/setup/post-delivery-deployment/api/m365-api/ 301
517517
/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
518518
/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
519-
/cloudflare-one/email-security/setup/post-delivery-deployment/bcc-journaling/journaling-setup/manage-domains/ /cloudflare-one/email-security/setup/manage-domains/ 301
519+
/cloudflare-one/email-security/setup/post-delivery-deployment/bcc-journaling/journaling-setup/manage-domains/ /cloudflare-one/email-security/setup/manage-domains/ 301
520520

521521
# firewall
522522
/firewall/api/cf-lists/ /waf/tools/lists/lists-api/ 301
@@ -1315,6 +1315,10 @@
13151315

13161316
# style guide
13171317

1318+
/docs-guide/ /style-guide/how-we-docs/ 301
1319+
/docs-guide/manage-content/ /style-guide/how-we-docs/ 301
1320+
/docs-guide/manage-content/automation/ /style-guide/how-we-docs/ 301
1321+
/docs-guide/manage-content/automation/process/ /style-guide/how-we-docs/ 301
13181322
/docs-guide/manage-content/redirects/ /style-guide/how-we-docs/redirects/ 301
13191323
/docs-guide/manage-content/redirects/best-practices/ /style-guide/how-we-docs/redirects/ 301
13201324
/docs-guide/manage-content/redirects/process/ /style-guide/how-we-docs/redirects/ 301
16.1 KB
Loading

src/content/docs/docs-guide/index.mdx

Lines changed: 0 additions & 10 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/automation/index.mdx

Lines changed: 0 additions & 29 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/automation/process.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/index.mdx

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Our site
4+
meta:
5+
title: Our site | How we docs
6+
---
7+
8+
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.
9+
10+
## Content management system
11+
12+
Our content lives in a public GitHub repository, [`cloudflare-docs`](https://github.com/cloudflare/cloudflare-docs).
13+
14+
GitHub offers a generous [free tier](https://github.com/pricing).
15+
16+
## Search
17+
18+
We use [Algolia](https://www.algolia.com/) as our search provider.
19+
20+
If you have open-source docs, you can be part of the free [DocSearch program](https://docsearch.algolia.com/).
21+
22+
## Site framework
23+
24+
We use [Starlight](https://starlight.astro.build/) for our docs, which is a free, custom documentation theme supported by [Astro](https://astro.build/).
25+
26+
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).
27+
28+
## Builds
29+
30+
We use [GitHub Actions](https://github.com/features/actions) to build our site, which is then [hosted](#hosting) on Cloudflare.
31+
32+
We are moving to [Workers CI/CD](/workers/ci-cd/), which currently runs in the background.
33+
34+
Both of these options include a free tier.
35+
36+
## Hosting
37+
38+
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/)
39+
40+
Workers offers a generous [free tier](/workers/platform/pricing/).
41+
42+
## Analytics
43+
44+
We send analytics to multiple destinations using [Cloudflare Zaraz](/zaraz/), which has a generous [free tier](/zaraz/pricing-info/).
45+
46+
:::note
47+
48+
If you want to opt out of analytics tracking, use the icon at the bottom of your screen.
49+
50+
![Opt out of analytics with the icon at the bottom of your screen](~/assets/images/style-guide/how-we-docs/privacy-opt-out.png)
51+
52+
:::

src/content/products/docs-guide.yml

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)