-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Refresh CloudCannon CMS guide #12698
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the instructions are pretty clear (except maybe a step, see my comment) and that seems enough to get started thanks to the links to CloudCannon docs.
We might also want to use valid HTML for the CTA component. Either the compiler or the browser will try to fix what we currently show...
Co-authored-by: Armand Philippot <[email protected]>
|
Note: from comments on Talking and Doc'ing will also be looking at the Keystatic CMS guide as a model for additional content e.g. rendering content |
|
Added content in the previous commit more to figure out structure/content than for ... complete accuracy. 😅 Basing the content on what I've read in their docs so far. Once we know what we want this page to look like, I'll go for accuracy! 😄 |
HiDeoo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, this feels like reading a totally improved guide from the one I read a few days ago! Amazing work 👏
This is only my own opinion, and may be influenced a lot by my own experience with CMS, but now, I feel like I have a total overview of the whole process of using CloudCannon & Astro, from managing content in CloudCannon, to rendering such content in Astro. End-to-end.
Adding a few comments below, mostly focusing on the structure and content at this point rather than grammar/spelling or anything like that.
|
|
||
| If you use [Astro's content collections](/en/guides/content-collections/), then you will be familiar with CloudCannon's concepts of collections (used for organization/navigation in your Site Dashboard) and schemas (used to define the format of new content entries). | ||
|
|
||
| Your CloudCannon Site Dashboard allows you to organize your Astro project's pages and content into collections: groups of related files with a similar format. This allows you to see similar types of content together for ease of editing and makes your content files easy to navigate, sort, and filter. You can set collection-level configuration features such as a folder path and output URL, as well as specify which editing views are available to editors working on files in this collection. This can be done through your Site Dashboard or by editing your CloudCannon configuration file directly in your Astro project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Your CloudCannon Site Dashboard allows you to organize your Astro project's pages and content into collections: groups of related files with a similar format. This allows you to see similar types of content together for ease of editing and makes your content files easy to navigate, sort, and filter. You can set collection-level configuration features such as a folder path and output URL, as well as specify which editing views are available to editors working on files in this collection. This can be done through your Site Dashboard or by editing your CloudCannon configuration file directly in your Astro project. | |
| Your CloudCannon Site Dashboard allows you to organize your Astro project's pages and content into collections: groups of related files with a similar format. This allows you to see similar types of content together for ease of editing and makes your content files easy to navigate, sort, and filter. |
This part feels like pretty advanced details to me, and I don't think (but maybe I'm wrong) that they add a lot of value when describing the overall concept of collections and schemas.
|
|
||
| By default, CloudCannon will automatically try to detect appropriate collections (e.g. blog posts, individual pages) when you first create your CloudCannon configuration file by searching your repository files for folders of similar content. You can also [manually group files into CloudCannon collections](https://cloudcannon.com/documentation/guides/getting-started-with-cloudcannon/group-files-into-collections/) to customize your view. | ||
|
|
||
| You can define blank entry templates for your content types by adding one or more [CloudCannon schemas](https://cloudcannon.com/documentation/articles/what-is-a-schema/). These allow you to quickly create new content entries (e.g. blog posts, newsletters, author pages) through your Site Dashboard that will have the proper default fields, ready to be filled in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like this part is mostly covered in the "Create a CloudCannon schema for a collection" section and introduce some extra complexity, e.g. "blank entry template", too early while this is properly explained later. Any thoughts?
| ``` | ||
| </Steps> | ||
| ### Configuring multiple schemas |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While totally correct, I think one important detail about this section is that it's entirely specific to CloudCannon and not mandatory if you want to understand how to use CloudCannon & Astro together.
I guess the question would be if the guide should be a thorough guide on how CloudCannon & Astro works together and can be used together, or should it also cover some advanced CloudCannon patterns.
|
|
||
| 4. When you are ready to commit this new post back to your Astro repository, select save in the Site navigation sidebar from your Site Dashboard. This will show you all unsaved changes made to your site since your last commit back to your repository and allow you to review and select which ones to save or discard. | ||
|
|
||
| 5. Return to view your Astro project files. You will now find a new `.md` file inside the specified directory for this new post, for example: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm guessing we should mention that you should pull new changes from git at this point?
| ``` | ||
| </Steps> | ||
|
|
||
| ## Rendering CloudCannon content |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this new section, so helpful to me to bridge the gap between the CMS/editor and Astro 👏
Description (required)
Updating CloudCannon CMS guide to coincide with more / better Astro support. (e.g. Editable components)
Focuses on the parts relevant to using with Astro.
Direct link to deploy preview of the guide: https://deploy-preview-12698--astro-docs-2.netlify.app/en/guides/cms/cloudcannon/