Skip to content

Commit 222184b

Browse files
patch: Add Docusaurus unpublish instructions
Signed-off-by: Vipul Gupta (@vipulgupta2048) <[email protected]>
1 parent d4aad09 commit 222184b

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Balena Docusaurus Theme
1+
# DocuBuilder: Deploy Docusaurus Websites at Scale
22

3-
> The `create-react-app` version of building docusaurus websites
3+
> The `create-react-app` way of building and deploying docusaurus websites
44
55
This is the official Docusaurus theme for balena docs.
66
[Docusaurus 2](https://docusaurus.io/) is a modern static website generator that we used to generate docs.
@@ -127,6 +127,16 @@ Cloudflare Pages lets us create preview releases for each open pull request. To
127127

128128
You can find the link on the Flowzone run's Summary page or in the logs for the GitHub task `Deploy to Cloudflare`.
129129

130+
## How to unpublish a Docusaurus website
131+
132+
To safely unpublish a docusaurus website, we need to undo or stop the steps taken by Flowzone to publish the Cloudflare Pages website. This can be done by following the steps below:
133+
134+
1. Create a pull request to amend `flowzone.yml` file. Delete the `cloudflare_website` property. Once the pull request is merged, the GitHub action will stop running and the website will not be updated on Cloudflare Pages.
135+
2. To remove the content from Cloudflare Pages, please navigate to `Cloudflare Pages & Workers` page and delete the project from the Cloudflare Pages dashboard.
136+
3. On removing the entry, Cloudflare will prompt you to also delete the DNS entry for the Cloudflare Page. Please confirm the deletion of the DNS entry as well.
137+
4. To prevent squatting on the Cloudflare Page, please create a new empty project of the same name to reclaim that domian. This will also help in preventing any future conflicts with the same domain name.
138+
5. (Optional) If needed, redirect the DNS entry to back to [balena.io](balena.io) or a new target to not lose the traffic or break the user experience. If you need help with this, please reach out to the ops team.
139+
130140
## Contributing
131141

132142
Refer to the offical [docusaurus documentation](https://docusaurus.io/) on exploring features and adding them to the docusaurus configuration here. To test your changes, the development docker image needs to be rebuilt. Use the following commands to initiate a fresh build of the docker image and create a container using that image.

0 commit comments

Comments
 (0)