Add content version management system tutorial

[shinchan79]

Summary

Add a new tutorial "Content Version Management System using Cloudflare Workers and Durable Objects."

Screenshots (optional)

Documentation checklist

• The documentation style guide has been adhered to.

Proposed changes

Added a new tutorial in the src/content/docs/workers/tutorials/build-a-content-version-system directory.

The functions which we will be covering in this tutorial are as follows:

• Create a new content
• Update the content
• Get the content (specific version and list of all versions)
• Revert to a specific version
• Publish or unpublish a version
• Detailed history of modifications
• Tag a version
• Delete a version (in case you do not need it anymore)

The functions are implemented on Cloudflare Workers and the states of the contents are managed on Durable Objects.

The tutorial used TypeScript code and Bash commands.
Code snippets and examples adhere to the Cloudflare documentation style guide.

[hyperlint-ai]

1 files reviewed, 1 total issue(s) found.

[hyperlint-ai]

1 files reviewed, 1 total issue(s) found.

[hyperlint-ai]

1 files reviewed, 1 total issue(s) found.

---

Note: We resolved prior Hyperlint review comments because:

We updated our inline suggestion AI.

We do this to avoid keeping outdated or irrelevant comments around. We'll leave a new review with current comments below.

[hyperlint-ai]

1 files reviewed, 3 total issue(s) found.

---

Note: We resolved prior Hyperlint review comments because:

We updated our inline suggestion AI.

We do this to avoid keeping outdated or irrelevant comments around. We'll leave a new review with current comments below.

[harshil1712]

Hey @shinchan79, this is great tutorial! However, I believe it needs some more work before it can be published. I have left a few comments, and here's my general feedback:

• Can we have explanation for the code blocks? The comments in the code are excellent, but an explanation outside of that will be helpful
• I get TypeScript errors when following the flow you describe: adding code to index.ts, handling request in DO, and then adding code functionality in DO. You reference methods and variables that are defined in the later steps. Seeing these errors can confuse the reader. Can we change the order?
• I am not sure if a front-end is needed for the tutorial. Your deployed link takes me to a Next.js app. However, I don't see that in here. Can you clarify that for me?

Thank you again for the contribution. This is a great tutorial and I am excited to see this get published.

[harshil1712]

This will result in a 404. Is there front-end coding missing with this project?

[shinchan79]

Actually because of the fact that the tutorial is quite long, I have remove the front end code, and add the link link to front end repo in the README of backend repo: https://github.com/shinchan79/content-version-system/blob/main/README.md#frontend-if-you-need-it-i-deployed-it-to-cloudflare-pages. Maybe I will remove this button if it makes reader confused

[harshil1712]

Since we are handling CORS in the worker, do we really need it here? When the request is made, it first goes through the Worker and only then to the Durable Object

[harshil1712]

While these are good, we should have more resources that can help the reader know about the next steps

[shinchan79]

@harshil1712 orry for the late reply. I was sick last week, and only today I'm able to work and update the PR based on your comments.

Please check and let me know if there is anything I should improve. Thank you so much!

[db-cloudflare]

A small suggestion, It might be also worth changing the folder name from build-a-content-version-system to build-a-version-control-system to match the new title.

[hyperlint-ai]

1 files reviewed, 3 total issue(s) found.

[hyperlint-ai]

1 files reviewed, 3 total issue(s) found.

[shinchan79]

@harshil1712 just want to ask if any other things should I improve after my most updated commit?

[harshil1712]

@harshil1712 just want to ask if any other things should I improve after my most updated commit?

Thank you for making the changes. I wasn't sure if it was ready for review. I will review it this week. Thank you!

[harshil1712]

Hey, I like where we are going with this! I have left a few comments. I was also wondering, do we need the front-end like we have in your finished demo? If so, can we add it in the tutorial? The front-end part can be something they can git clone, maybe? Also, we can use Workers Static Assets to serve the front-end. This will allow us to have it all in a single repo

[harshil1712]

This is good to have, but not required. If we want to keep it, it would be nice to add one-two line telling the reader what it is and link it to the docs

[shinchan79]

@harshil1712 I have read all your comment. Thanks for helping me write a better article. Please give me some days, I will try my best to resolves all the comments next week. Thank you so much!

[shinchan79]

I will also edit a little bit in the front-end repo so that the code is more understandable, and will insert the link in the tutorial for whoever need frontend part.

[harshil1712]

Let's update to something as follows:

"scripts": {
...
    "lint": "npx eslint . --ext .ts --fix",
    "format": "prettier --write .",
    "test": "vitest run",
    "test:watch": "vitest"
  }

If the reader simply copy pastes this, they might overwrite the existing scripts and run into error when running commands like npm run dev

[harshil1712]

When running the command npm run cf-typegen we are already getting this type. We don't need to define it again.

[harshil1712]

We haven't defined the DO class. This will throw an error. We should move the DO code before this, or add note letting the user know that an error is expected.

[harshil1712]

Why do we need CORS? Since we are not calling the worker from another URL, this shouldn't be required.

[harshil1712]

Same as the previous comment on CORS

[kodster28]

This PR has been sitting for quite a while without any updates (or response to the comments dropped by @harshil1712).

Going to close it out for now. If you want to continue with the work, you'll need to make a new one.